Overview

Namespaces

  • BeerXML
    • Exception
    • Generator
    • Parser
    • Record
  • PHP

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Record
  • Style
  • Water
  • Yeast

Interfaces

  • IEquipment
  • IEquipmentDisplay
  • IFermentable
  • IFermentableDisplay
  • IHop
  • IHopDisplay
  • IMashProfile
  • IMashProfileDisplay
  • IMashStep
  • IMashStepDisplay
  • IMisc
  • IMiscDisplay
  • IRecipe
  • IRecipeDisplay
  • IStyle
  • IStyleDisplay
  • IWater
  • IWaterDisplay
  • IYeast
  • IYeastDisplay
  • Overview
  • Namespace
  • Class
  • Tree

Interface IMashStepDisplay

BeerXML\Generator\IMashStepDisplay implements BeerXML\Generator\IMashStep

Direct known implementers

BeerXML\Record\MashStep
Namespace: BeerXML\Generator
Located at BeerXML/Generator/IMashStepDisplay.php
Methods summary
public string
# getDecoctionAmt( )

Calculated volume of mash to decoct. Only applicable for a decoction step. Includes the units as in "7.5 l" or "2.3 gal"

Calculated volume of mash to decoct. Only applicable for a decoction step. Includes the units as in "7.5 l" or "2.3 gal"

Returns

string
public string
# getDescription( )

Textual description of this step such as "Infuse 4.5 gal of water at 170 F" – may be either generated by the program or input by the user.

Textual description of this step such as "Infuse 4.5 gal of water at 170 F" – may be either generated by the program or input by the user.

Returns

string
public string
# getDisplayInfuseAmt( )

Infusion amount along with the volume units as in "20 l" or "13 qt"

Infusion amount along with the volume units as in "20 l" or "13 qt"

Returns

string
public string
# getDisplayStepTemp( )

Step temperature in user defined temperature units. For example "154F" or "68 C"

Step temperature in user defined temperature units. For example "154F" or "68 C"

Returns

string
public string
# getInfuseTemp( )

The calculated infusion temperature based on the current step, grain, and other settings. Applicable only for an infusion step. Includes the units as in "154 F" or "68 C"

The calculated infusion temperature based on the current step, grain, and other settings. Applicable only for an infusion step. Includes the units as in "154 F" or "68 C"

Returns

string
public string
# getWaterGrainRatio( )

The total ratio of water to grain for this step AFTER the infusion along with the units, usually expressed in qt/lb or l/kg.

The total ratio of water to grain for this step AFTER the infusion along with the units, usually expressed in qt/lb or l/kg.

Note this value must be consistent with the required infusion amount and amounts added in earlier steps and is only relevant as part of a <MASH> profile. For example "1.5 qt/lb" or "3.0 l/kg"

Returns

string
Methods inherited from BeerXML\Generator\IMashStep
getEndTemp(), getInfuseAmount(), getName(), getRampTime(), getStepTemp(), getStepTime(), getType(), getVersion()
php-beerxml API documentation generated by ApiGen 2.8.0