Overview

Namespaces

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

Classes

  • Equipment
  • Fermentable
  • Hop
  • MashProfile
  • MashStep
  • Misc
  • Recipe
  • Style
  • Water
  • Yeast
  • Overview
  • Namespace
  • Class
  • Tree

Class MashStep

BeerXML\Record\MashStep implements BeerXML\Generator\IMashStepDisplay, BeerXML\Parser\IMashStepDisplay
Namespace: BeerXML\Record
Located at BeerXML/Record/MashStep.php
Methods summary
public
# setEndTemp( number $endTemp )

the temperature you can expect the mash to fall to after a long mash step. Measured in degrees Celsius.

the temperature you can expect the mash to fall to after a long mash step. Measured in degrees Celsius.

Parameters

$endTemp
number
$endTemp

Implementation of

BeerXML\Parser\IMashStep::setEndTemp()
public number
# getEndTemp( )

the temperature you can expect the mash to fall to after a long mash step. Measured in degrees Celsius.

the temperature you can expect the mash to fall to after a long mash step. Measured in degrees Celsius.

Returns

number

Implementation of

BeerXML\Generator\IMashStep::getEndTemp()
public
# setInfuseAmount( number $infuseAmount )

The volume of water in liters to infuse in this step. Required only for infusion steps, though one may also add water for temperature mash steps. One should not have an infusion amount for decoction steps.

The volume of water in liters to infuse in this step. Required only for infusion steps, though one may also add water for temperature mash steps. One should not have an infusion amount for decoction steps.

Parameters

$infuseAmount
number
$infuseAmount

Implementation of

BeerXML\Parser\IMashStep::setInfuseAmount()
public number
# getInfuseAmount( )

The volume of water in liters to infuse in this step. Required only for infusion steps, though one may also add water for temperature mash steps. One should not have an infusion amount for decoction steps.

The volume of water in liters to infuse in this step. Required only for infusion steps, though one may also add water for temperature mash steps. One should not have an infusion amount for decoction steps.

Returns

number

Implementation of

BeerXML\Generator\IMashStep::getInfuseAmount()
public
# setName( string $name )

Name of the mash step – usually descriptive text such as "Dough In" or "Conversion"

Name of the mash step – usually descriptive text such as "Dough In" or "Conversion"

Parameters

$name
string
$name

Implementation of

BeerXML\Parser\IMashStep::setName()
public string
# getName( )

Name of the mash step – usually descriptive text such as "Dough In" or "Conversion"

Name of the mash step – usually descriptive text such as "Dough In" or "Conversion"

Returns

string

Implementation of

BeerXML\Generator\IMashStep::getName()
public
# setRampTime( number $rampTime )

Time in minutes to achieve the desired step temperature – useful particularly for temperature mashes where it may take some time to achieve the step temperature.

Time in minutes to achieve the desired step temperature – useful particularly for temperature mashes where it may take some time to achieve the step temperature.

Parameters

$rampTime
number
$rampTime

Implementation of

BeerXML\Parser\IMashStep::setRampTime()
public number
# getRampTime( )

Time in minutes to achieve the desired step temperature – useful particularly for temperature mashes where it may take some time to achieve the step temperature.

Time in minutes to achieve the desired step temperature – useful particularly for temperature mashes where it may take some time to achieve the step temperature.

Returns

number

Implementation of

BeerXML\Generator\IMashStep::getRampTime()
public
# setStepTemp( number $stepTemp )

The target temperature for this step in degrees Celsius.

The target temperature for this step in degrees Celsius.

Parameters

$stepTemp
number
$stepTemp

Implementation of

BeerXML\Parser\IMashStep::setStepTemp()
public number
# getStepTemp( )

The target temperature for this step in degrees Celsius.

The target temperature for this step in degrees Celsius.

Returns

number

Implementation of

BeerXML\Generator\IMashStep::getStepTemp()
public
# setStepTime( number $stepTime )

The number of minutes to spend at this step – i.e. the amount of time we are to hold this particular step temperature.

The number of minutes to spend at this step – i.e. the amount of time we are to hold this particular step temperature.

Parameters

$stepTime
number
$stepTime

Implementation of

BeerXML\Parser\IMashStep::setStepTime()
public number
# getStepTime( )

The number of minutes to spend at this step – i.e. the amount of time we are to hold this particular step temperature.

The number of minutes to spend at this step – i.e. the amount of time we are to hold this particular step temperature.

Returns

number

Implementation of

BeerXML\Generator\IMashStep::getStepTime()
public
# setType( string $type )

May be "Infusion", "Temperature" or "Decoction" depending on the type of step. Infusion denotes adding hot water, Temperature denotes heating with an outside heat source, and decoction denotes drawing off some mash for boiling.

May be "Infusion", "Temperature" or "Decoction" depending on the type of step. Infusion denotes adding hot water, Temperature denotes heating with an outside heat source, and decoction denotes drawing off some mash for boiling.

Parameters

$type
string
$type

Implementation of

BeerXML\Parser\IMashStep::setType()
public string
# getType( )

May be "Infusion", "Temperature" or "Decoction" depending on the type of step. Infusion denotes adding hot water, Temperature denotes heating with an outside heat source, and decoction denotes drawing off some mash for boiling.

May be "Infusion", "Temperature" or "Decoction" depending on the type of step. Infusion denotes adding hot water, Temperature denotes heating with an outside heat source, and decoction denotes drawing off some mash for boiling.

Returns

string

Implementation of

BeerXML\Generator\IMashStep::getType()
public
# setVersion( integer $version )

Version of the mash step record. Should always be "1" for this version of the XML standard.

Version of the mash step record. Should always be "1" for this version of the XML standard.

Parameters

$version
integer
$version

Implementation of

BeerXML\Parser\IMashStep::setVersion()
public integer
# getVersion( )

Version of the mash step record. Should always be "1" for this version of the XML standard.

Version of the mash step record. Should always be "1" for this version of the XML standard.

Returns

integer

Implementation of

BeerXML\Generator\IMashStep::getVersion()
public
# setDecoctionAmt( string $decoctionAmt )

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"

Parameters

$decoctionAmt
string
$decoctionAmt

Implementation of

BeerXML\Parser\IMashStepDisplay::setDecoctionAmt()
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

Implementation of

BeerXML\Generator\IMashStepDisplay::getDecoctionAmt()
public
# setDescription( string $description )

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.

Parameters

$description
string
$description

Implementation of

BeerXML\Parser\IMashStepDisplay::setDescription()
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

Implementation of

BeerXML\Generator\IMashStepDisplay::getDescription()
public
# setDisplayInfuseAmt( string $displayInfuseAmt )

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"

Parameters

$displayInfuseAmt
string
$displayInfuseAmt

Implementation of

BeerXML\Parser\IMashStepDisplay::setDisplayInfuseAmt()
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

Implementation of

BeerXML\Generator\IMashStepDisplay::getDisplayInfuseAmt()
public
# setDisplayStepTemp( string $displayStepTemp )

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"

Parameters

$displayStepTemp
string
$displayStepTemp

Implementation of

BeerXML\Parser\IMashStepDisplay::setDisplayStepTemp()
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

Implementation of

BeerXML\Generator\IMashStepDisplay::getDisplayStepTemp()
public
# setInfuseTemp( string $infuseTemp )

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"

Parameters

$infuseTemp
string
$infuseTemp

Implementation of

BeerXML\Parser\IMashStepDisplay::setInfuseTemp()
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

Implementation of

BeerXML\Generator\IMashStepDisplay::getInfuseTemp()
public
# setWaterGrainRatio( string $waterGrainRatio )

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"

Parameters

$waterGrainRatio
string
$waterGrainRatio

Implementation of

BeerXML\Parser\IMashStepDisplay::setWaterGrainRatio()
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

Implementation of

BeerXML\Generator\IMashStepDisplay::getWaterGrainRatio()
Constants summary
string TYPE_INFUSION 'Infusion'
#
string TYPE_TEMPERATURE 'Temperature'
#
string TYPE_DECOCTION 'Decoction'
#
php-beerxml API documentation generated by ApiGen 2.8.0