Interface IEquipment

Direct known implementers

BeerXML\Generator\IEquipmentDisplay

Indirect known implementers

BeerXML\Record\Equipment

Namespace: BeerXML\Generator
Located at BeerXML/Generator/IEquipment.php

Methods summary
`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`
`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`
`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`
`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`
`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`
`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`
`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`
`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`
`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`
`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`
`public float`	# `getTopUpWater( )` Returns `float`
`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`
`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`
`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`
`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`
`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`