Overview

Namespaces

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

Classes

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

Class Equipment

BeerXML\Record\Equipment implements BeerXML\Generator\IEquipmentDisplay, BeerXML\Parser\IEquipmentDisplay
Namespace: BeerXML\Record
Located at BeerXML/Record/Equipment.php
Methods summary
public
# setBatchSize( float $batchSize )

The target volume of the batch at the start of fermentation.

The target volume of the batch at the start of fermentation.

Parameters

$batchSize
float
$batchSize

Implementation of

BeerXML\Parser\IEquipment::setBatchSize()
public float
# getBatchSize( )

The target volume of the batch at the start of fermentation.

The target volume of the batch at the start of fermentation.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getBatchSize()
public
# setBoilSize( float $boilSize )

The pre-boil volume used in this particular instance for this equipment setup. Note that this may be a calculated value depending on the CALC_BOIL_VOLUME parameter.

The pre-boil volume used in this particular instance for this equipment setup. Note that this may be a calculated value depending on the CALC_BOIL_VOLUME parameter.

Parameters

$boilSize
float
$boilSize

Implementation of

BeerXML\Parser\IEquipment::setBoilSize()
public float
# getBoilSize( )

The pre-boil volume used in this particular instance for this equipment setup. Note that this may be a calculated value depending on the CALC_BOIL_VOLUME parameter.

The pre-boil volume used in this particular instance for this equipment setup. Note that this may be a calculated value depending on the CALC_BOIL_VOLUME parameter.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getBoilSize()
public
# setBoilTime( number $boilTime )

The normal amount of time one boils for this equipment setup. This can be used with the evaporation rate to calculate the evaporation loss.

The normal amount of time one boils for this equipment setup. This can be used with the evaporation rate to calculate the evaporation loss.

Parameters

$boilTime
number
$boilTime

Implementation of

BeerXML\Parser\IEquipment::setBoilTime()
public number
# getBoilTime( )

The normal amount of time one boils for this equipment setup. This can be used with the evaporation rate to calculate the evaporation loss.

The normal amount of time one boils for this equipment setup. This can be used with the evaporation rate to calculate the evaporation loss.

Returns

number

Implementation of

BeerXML\Generator\IEquipment::getBoilTime()
public
# setCalcBoilVolume( boolean $calcBoilVolume )

Flag denoting that the program should calculate the boil size. Flag may be TRUE or FALSE. If TRUE, then BOIL_SIZE = (BATCH_SIZE – TOP_UP_WATER – TRUB_CHILLER_LOSS) * (1+BOIL_TIME * EVAP_RATE ) If set then the boil size should match this value.

Flag denoting that the program should calculate the boil size. Flag may be TRUE or FALSE. If TRUE, then BOIL_SIZE = (BATCH_SIZE – TOP_UP_WATER – TRUB_CHILLER_LOSS) * (1+BOIL_TIME * EVAP_RATE ) If set then the boil size should match this value.

Parameters

$calcBoilVolume
boolean
$calcBoilVolume

Implementation of

BeerXML\Parser\IEquipment::setCalcBoilVolume()
public boolean
# getCalcBoilVolume( )

Flag denoting that the program should calculate the boil size. Flag may be TRUE or FALSE. If TRUE, then BOIL_SIZE = (BATCH_SIZE – TOP_UP_WATER – TRUB_CHILLER_LOSS) * (1+BOIL_TIME * EVAP_RATE ) If set then the boil size should match this value.

Flag denoting that the program should calculate the boil size. Flag may be TRUE or FALSE. If TRUE, then BOIL_SIZE = (BATCH_SIZE – TOP_UP_WATER – TRUB_CHILLER_LOSS) * (1+BOIL_TIME * EVAP_RATE ) If set then the boil size should match this value.

Returns

boolean

Implementation of

BeerXML\Generator\IEquipment::getCalcBoilVolume()
public
# setEvapRate( float $evapRate )

The percentage of wort lost to evaporation per hour of the boil.

The percentage of wort lost to evaporation per hour of the boil.

Parameters

$evapRate
float
$evapRate

Implementation of

BeerXML\Parser\IEquipment::setEvapRate()
public float
# getEvapRate( )

The percentage of wort lost to evaporation per hour of the boil.

The percentage of wort lost to evaporation per hour of the boil.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getEvapRate()
public
# setHopUtilization( float $hopUtilization )

Large batch hop utilization. This value should be 100% for batches less than 20 gallons, but may be higher (200% or more) for very large batch equipment.

Large batch hop utilization. This value should be 100% for batches less than 20 gallons, but may be higher (200% or more) for very large batch equipment.

Parameters

$hopUtilization
float
$hopUtilization

Implementation of

BeerXML\Parser\IEquipment::setHopUtilization()
public float
# getHopUtilization( )

Large batch hop utilization. This value should be 100% for batches less than 20 gallons, but may be higher (200% or more) for very large batch equipment.

Large batch hop utilization. This value should be 100% for batches less than 20 gallons, but may be higher (200% or more) for very large batch equipment.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getHopUtilization()
public
# setLauterDeadspace( number $lauterDeadspace )

Amount lost to the lauter tun and equipment associated with the lautering process.

Amount lost to the lauter tun and equipment associated with the lautering process.

Parameters

$lauterDeadspace
number
$lauterDeadspace

Implementation of

BeerXML\Parser\IEquipment::setLauterDeadspace()
public number
# getLauterDeadspace( )

Amount lost to the lauter tun and equipment associated with the lautering process.

Amount lost to the lauter tun and equipment associated with the lautering process.

Returns

number

Implementation of

BeerXML\Generator\IEquipment::getLauterDeadspace()
public
# setName( string $name )

Name of the equipment profile – usually a text description of the brewing setup.

Name of the equipment profile – usually a text description of the brewing setup.

Parameters

$name
string
$name

Implementation of

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

Name of the equipment profile – usually a text description of the brewing setup.

Name of the equipment profile – usually a text description of the brewing setup.

Returns

string

Implementation of

BeerXML\Generator\IEquipment::getName()
public
# setNotes( string $notes )

Notes associated with the equipment. May be a multiline entry.

Notes associated with the equipment. May be a multiline entry.

Parameters

$notes
string
$notes

Implementation of

BeerXML\Parser\IEquipment::setNotes()
public string
# getNotes( )

Notes associated with the equipment. May be a multiline entry.

Notes associated with the equipment. May be a multiline entry.

Returns

string

Implementation of

BeerXML\Generator\IEquipment::getNotes()
public
# setTopUpKettle( number $topUpKettle )

Amount normally added to the boil kettle before the boil.

Amount normally added to the boil kettle before the boil.

Parameters

$topUpKettle
number
$topUpKettle

Implementation of

BeerXML\Parser\IEquipment::setTopUpKettle()
public number
# getTopUpKettle( )

Amount normally added to the boil kettle before the boil.

Amount normally added to the boil kettle before the boil.

Returns

number

Implementation of

BeerXML\Generator\IEquipment::getTopUpKettle()
public
# setTopUpWater( float $topUpWater )

Parameters

$topUpWater
float
$topUpWater

Implementation of

BeerXML\Parser\IEquipment::setTopUpWater()
public float
# getTopUpWater( )

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getTopUpWater()
public
# setTrubChillerLoss( float $trubChillerLoss )

The amount of wort normally lost during transition from the boiler to the fermentation vessel. Includes both unusable wort due to trub and wort lost to the chiller and transfer systems.

The amount of wort normally lost during transition from the boiler to the fermentation vessel. Includes both unusable wort due to trub and wort lost to the chiller and transfer systems.

Parameters

$trubChillerLoss
float
$trubChillerLoss

Implementation of

BeerXML\Parser\IEquipment::setTrubChillerLoss()
public float
# getTrubChillerLoss( )

The amount of wort normally lost during transition from the boiler to the fermentation vessel. Includes both unusable wort due to trub and wort lost to the chiller and transfer systems.

The amount of wort normally lost during transition from the boiler to the fermentation vessel. Includes both unusable wort due to trub and wort lost to the chiller and transfer systems.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getTrubChillerLoss()
public
# setTunSpecificHeat( float $tunSpecificHeat )

The specific heat of the mash tun which is usually a function of the material it is made of. Typical ranges are 0.1-0.25 for metal and 0.2-0.5 for plastic materials.

The specific heat of the mash tun which is usually a function of the material it is made of. Typical ranges are 0.1-0.25 for metal and 0.2-0.5 for plastic materials.

Parameters

$tunSpecificHeat
float
$tunSpecificHeat

Implementation of

BeerXML\Parser\IEquipment::setTunSpecificHeat()
public float
# getTunSpecificHeat( )

The specific heat of the mash tun which is usually a function of the material it is made of. Typical ranges are 0.1-0.25 for metal and 0.2-0.5 for plastic materials.

The specific heat of the mash tun which is usually a function of the material it is made of. Typical ranges are 0.1-0.25 for metal and 0.2-0.5 for plastic materials.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getTunSpecificHeat()
public
# setTunVolume( float $tunVolume )

Volume of the mash tun in liters. This parameter can be used to calculate if a particular mash and grain profile will fit in the mash tun. It may also be used for thermal calculations in the case of a partially full mash tun.

Volume of the mash tun in liters. This parameter can be used to calculate if a particular mash and grain profile will fit in the mash tun. It may also be used for thermal calculations in the case of a partially full mash tun.

Parameters

$tunVolume
float
$tunVolume

Implementation of

BeerXML\Parser\IEquipment::setTunVolume()
public float
# getTunVolume( )

Volume of the mash tun in liters. This parameter can be used to calculate if a particular mash and grain profile will fit in the mash tun. It may also be used for thermal calculations in the case of a partially full mash tun.

Volume of the mash tun in liters. This parameter can be used to calculate if a particular mash and grain profile will fit in the mash tun. It may also be used for thermal calculations in the case of a partially full mash tun.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getTunVolume()
public
# setTunWeight( float $tunWeight )

Weight of the mash tun in kilograms. Used primarily to calculate the thermal parameters of the mash tun – in conjunction with the volume and specific heat.

Weight of the mash tun in kilograms. Used primarily to calculate the thermal parameters of the mash tun – in conjunction with the volume and specific heat.

Parameters

$tunWeight
float
$tunWeight

Implementation of

BeerXML\Parser\IEquipment::setTunWeight()
public float
# getTunWeight( )

Weight of the mash tun in kilograms. Used primarily to calculate the thermal parameters of the mash tun – in conjunction with the volume and specific heat.

Weight of the mash tun in kilograms. Used primarily to calculate the thermal parameters of the mash tun – in conjunction with the volume and specific heat.

Returns

float

Implementation of

BeerXML\Generator\IEquipment::getTunWeight()
public
# setVersion( integer $version )

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

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

Parameters

$version
integer
$version

Implementation of

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

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

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

Returns

integer

Implementation of

BeerXML\Generator\IEquipment::getVersion()
public
# setDisplayBatchSize( string $displayBatchSize )

The target volume of the batch at the start of fermentation in display volume units such as "5.0 gal"

The target volume of the batch at the start of fermentation in display volume units such as "5.0 gal"

Parameters

$displayBatchSize
string
$displayBatchSize

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayBatchSize()
public string
# getDisplayBatchSize( )

The target volume of the batch at the start of fermentation in display volume units such as "5.0 gal"

The target volume of the batch at the start of fermentation in display volume units such as "5.0 gal"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayBatchSize()
public
# setDisplayBoilSize( string $displayBoilSize )

The pre-boil volume normally used for a batch of this size shown in display volume units such as "5.5 gal"

The pre-boil volume normally used for a batch of this size shown in display volume units such as "5.5 gal"

Parameters

$displayBoilSize
string
$displayBoilSize

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayBoilSize()
public string
# getDisplayBoilSize( )

The pre-boil volume normally used for a batch of this size shown in display volume units such as "5.5 gal"

The pre-boil volume normally used for a batch of this size shown in display volume units such as "5.5 gal"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayBoilSize()
public
# setDisplayLauterDeadspace( string $displayLauterDeadspace )

Amount lost to the lauter tun and equipment associated with the lautering process. Ex: "2.0 gal" or "1.0 l"

Amount lost to the lauter tun and equipment associated with the lautering process. Ex: "2.0 gal" or "1.0 l"

Parameters

$displayLauterDeadspace
string
$displayLauterDeadspace

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayLauterDeadspace()
public string
# getDisplayLauterDeadspace( )

Amount lost to the lauter tun and equipment associated with the lautering process. Ex: "2.0 gal" or "1.0 l"

Amount lost to the lauter tun and equipment associated with the lautering process. Ex: "2.0 gal" or "1.0 l"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayLauterDeadspace()
public
# setDisplayTopUpKettle( string $displayTopUpKettle )

Amount normally added to the boil kettle before the boil. Ex: "1.0 gal"

Amount normally added to the boil kettle before the boil. Ex: "1.0 gal"

Parameters

$displayTopUpKettle
string
$displayTopUpKettle

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayTopUpKettle()
public string
# getDisplayTopUpKettle( )

Amount normally added to the boil kettle before the boil. Ex: "1.0 gal"

Amount normally added to the boil kettle before the boil. Ex: "1.0 gal"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayTopUpKettle()
public
# setDisplayTopUpWater( string $displayTopUpWater )

The amount of top up water normally added just prior to starting fermentation in display volume such as "1.0 gal"

The amount of top up water normally added just prior to starting fermentation in display volume such as "1.0 gal"

Parameters

$displayTopUpWater
string
$displayTopUpWater

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayTopUpWater()
public string
# getDisplayTopUpWater( )

The amount of top up water normally added just prior to starting fermentation in display volume such as "1.0 gal"

The amount of top up water normally added just prior to starting fermentation in display volume such as "1.0 gal"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayTopUpWater()
public
# setDisplayTrubChillerLoss( string $displayTrubChillerLoss )

The amount of wort normally lost during transition from the boiler to the fermentation vessel.

The amount of wort normally lost during transition from the boiler to the fermentation vessel.

Includes both unusable wort due to trub and wort lost to the chiller and transfer systems. Expressed in user units - Ex: "1.5 qt"

Parameters

$displayTrubChillerLoss
string
$displayTrubChillerLoss

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayTrubChillerLoss()
public string
# getDisplayTrubChillerLoss( )

The amount of wort normally lost during transition from the boiler to the fermentation vessel.

The amount of wort normally lost during transition from the boiler to the fermentation vessel.

Includes both unusable wort due to trub and wort lost to the chiller and transfer systems. Expressed in user units - Ex: "1.5 qt"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayTrubChillerLoss()
public
# setDisplayTunVolume( string $displayTunVolume )

Volume of the mash tun in display units such as "10.0 gal" or "20.0 l"

Volume of the mash tun in display units such as "10.0 gal" or "20.0 l"

Parameters

$displayTunVolume
string
$displayTunVolume

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayTunVolume()
public string
# getDisplayTunVolume( )

Volume of the mash tun in display units such as "10.0 gal" or "20.0 l"

Volume of the mash tun in display units such as "10.0 gal" or "20.0 l"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayTunVolume()
public
# setDisplayTunWeight( string $displayTunWeight )

Weight of the mash tun in display units such as "3.0 kg" or "6.0 lb"

Weight of the mash tun in display units such as "3.0 kg" or "6.0 lb"

Parameters

$displayTunWeight
string
$displayTunWeight

Implementation of

BeerXML\Parser\IEquipmentDisplay::setDisplayTunWeight()
public string
# getDisplayTunWeight( )

Weight of the mash tun in display units such as "3.0 kg" or "6.0 lb"

Weight of the mash tun in display units such as "3.0 kg" or "6.0 lb"

Returns

string

Implementation of

BeerXML\Generator\IEquipmentDisplay::getDisplayTunWeight()
php-beerxml API documentation generated by ApiGen 2.8.0