Interface IFermentable

Direct known implementers

BeerXML\Generator\IFermentableDisplay

Indirect known implementers

BeerXML\Record\Fermentable

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

Methods summary
`public boolean`	# `getAddAfterBoil( )` May be TRUE if this item is normally added after the boil. The default value is FALSE since most grains are added during the mash or boil. May be TRUE if this item is normally added after the boil. The default value is FALSE since most grains are added during the mash or boil. Returns `boolean`
`public number`	# `getAmount( )` Weight of the fermentable, extract or sugar in Kilograms. Weight of the fermentable, extract or sugar in Kilograms. Returns `number`
`public number`	# `getCoarseFineDiff( )` Percent difference between the coarse grain yield and fine grain yield. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. Percent difference between the coarse grain yield and fine grain yield. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. Returns `number`
`public float`	# `getColor( )` The color of the item in Lovibond Units (SRM for liquid extracts). The color of the item in Lovibond Units (SRM for liquid extracts). Returns `float`
`public float`	# `getDiastaticPower( )` The diastatic power of the grain as measured in "Lintner" units. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. The diastatic power of the grain as measured in "Lintner" units. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. Returns `float`
`public float`	# `getIbuGalPerLb( )` For hopped extracts only - an estimate of the number of IBUs per pound of extract in a gallon of water. To convert to IBUs we multiply this number by the "AMOUNT" field (in pounds) and divide by the number of gallons in the batch. Based on a sixty minute boil. Only suitable for use with an "Extract" type, otherwise this value is ignored. For hopped extracts only - an estimate of the number of IBUs per pound of extract in a gallon of water. To convert to IBUs we multiply this number by the "AMOUNT" field (in pounds) and divide by the number of gallons in the batch. Based on a sixty minute boil. Only suitable for use with an "Extract" type, otherwise this value is ignored. Returns `float`
`public number`	# `getMaxInBatch( )` The recommended maximum percentage (by weight) this ingredient should represent in a batch of beer. The recommended maximum percentage (by weight) this ingredient should represent in a batch of beer. Returns `number`
`public number`	# `getMoisture( )` Percent moisture in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. Percent moisture in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. Returns `number`
`public string`	# `getName( )` Name of the fermentable. Name of the fermentable. Returns `string`
`public string`	# `getNotes( )` Textual noted describing this ingredient and its use. May be multiline. Textual noted describing this ingredient and its use. May be multiline. Returns `string`
`public string`	# `getOrigin( )` Country or place of origin Country or place of origin Returns `string`
`public number`	# `getProtein( )` The percent protein in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. The percent protein in the grain. Only appropriate for a "Grain" or "Adjunct" type, otherwise this value is ignored. Returns `number`
`public boolean`	# `getRecommendMash( )` TRUE if it is recommended the grain be mashed, FALSE if it can be steeped. A value of TRUE is only appropriate for a "Grain" or "Adjunct" types. The default value is FALSE. Note that this does NOT indicate whether the grain is mashed or not – it is only a recommendation used in recipe formulation. TRUE if it is recommended the grain be mashed, FALSE if it can be steeped. A value of TRUE is only appropriate for a "Grain" or "Adjunct" types. The default value is FALSE. Note that this does NOT indicate whether the grain is mashed or not – it is only a recommendation used in recipe formulation. Returns `boolean`
`public string`	# `getSupplier( )` Supplier of the grain/extract/sugar Supplier of the grain/extract/sugar Returns `string`
`public string`	# `getType( )` May be "Grain", "Sugar", "Extract", "Dry Extract" or "Adjunct". Extract refers to liquid extract. May be "Grain", "Sugar", "Extract", "Dry Extract" or "Adjunct". Extract refers to liquid extract. Returns `string`
`public integer`	# `getVersion( )` Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible. Should be set to 1 for this version of the XML standard. May be a higher number for later versions but all later versions shall be backward compatible. Returns `integer`
`public number`	# `getYield( )` Percent dry yield (fine grain) for the grain, or the raw yield by weight if this is an extract adjunct or sugar. Percent dry yield (fine grain) for the grain, or the raw yield by weight if this is an extract adjunct or sugar. Returns `number`