Methods summary
public
number
|
#
getAge( )
The time to age the beer in days after bottling.
The time to age the beer in days after bottling.
Returns
number
Time (days)
|
public
number
|
#
getAgeTemp( )
Temperature for aging the beer after bottling.
Temperature for aging the beer after bottling.
Returns
number
Temperature C
|
public
string
|
#
getAsstBrewer( )
Optional name of the assistant brewer
Optional name of the assistant brewer
Returns
string
|
public
float
|
#
getBatchSize( )
Target size of the finished batch in liters.
Target size of the finished batch in liters.
Returns
float
Volume (liters)
|
public
float
|
#
getBoilSize( )
Starting size for the main boil of the wort in liters.
Starting size for the main boil of the wort in liters.
Returns
float
Volume (liters)
|
public
number
|
#
getBoilTime( )
The total time to boil the wort in minutes.
The total time to boil the wort in minutes.
Returns
number
Time in minutes
|
public
string
|
|
public
float
|
#
getCarbonation( )
Floating point value corresponding to the target volumes of CO2 used to
carbonate this beer.
Floating point value corresponding to the target volumes of CO2 used to
carbonate this beer.
Returns
float
Volumes of CO2
|
public
number
|
#
getCarbonationTemp( )
The temperature for either bottling or forced carbonation.
The temperature for either bottling or forced carbonation.
Returns
number
Temperature (degrees C)
|
public
DateTime
|
#
getDate( )
Date brewed in a easily recognizable format such as "3 Dec 04".
Date brewed in a easily recognizable format such as "3 Dec 04".
Returns
|
public
float
|
#
getEfficiency( )
The percent brewhouse efficiency to be used for estimating the starting
gravity of the beer.
The percent brewhouse efficiency to be used for estimating the starting
gravity of the beer.
Not required for "Extract" recipes, but is required for "Partial Mash" and
"All Grain" recipes.
Returns
float
(e.g. 72.3)
|
public
BeerXML\Generator\IEquipment
|
#
getEquipment( )
An equipment record is optional.
An equipment record is optional.
If included the BATCH_SIZE and BOIL_SIZE in the equipment record must match
the values in this recipe record.
Returns
|
public
BeerXML\Generator\IFermentable[]
|
#
getFermentables( )
Zero or more FERMENTABLE ingredients may appear between the
<FERMENTABLES> … </FERMENTABLES> tags.
Zero or more FERMENTABLE ingredients may appear between the
<FERMENTABLES> … </FERMENTABLES> tags.
Returns
|
public
integer
|
#
getFermentationStages( )
The number of fermentation stages used – typically a number between one and
three
The number of fermentation stages used – typically a number between one and
three
Returns
integer
|
public
float
|
#
getFg( )
The measured final gravity of the finished beer.
The measured final gravity of the finished beer.
Returns
float
Specific Gravity
|
public
boolean
|
#
getForcedCarbonation( )
TRUE if the batch was force carbonated using CO2 pressure, FALSE if the batch
was carbonated using a priming agent.
TRUE if the batch was force carbonated using CO2 pressure, FALSE if the batch
was carbonated using a priming agent.
Default is FALSE
Returns
boolean
|
public
BeerXML\Generator\IHop[]
|
#
getHops( )
Zero or more HOP ingredient records may appear between the
<HOPS>…</HOPS> tags.
Zero or more HOP ingredient records may appear between the
<HOPS>…</HOPS> tags.
Returns
|
public
float
|
#
getKegPrimingFactor( )
Used to factor in the smaller amount of sugar needed for large
containers.
Used to factor in the smaller amount of sugar needed for large
containers.
For example, this might be 0.5 for a typical 5 gallon keg since naturally
priming a keg requires about 50% as much sugar as priming bottles.
Returns
float
|
public
BeerXML\Generator\IMashProfile
|
#
getMash( )
A MASH profile record containing one or more MASH_STEPs.
A MASH profile record containing one or more MASH_STEPs.
NOTE: No Mash record is needed for "Extract" type brews.
Returns
|
public
BeerXML\Generator\IMisc[]
|
#
getMiscs( )
Zero or more MISC records may appear between <MISCS> …
</MISCS>
Zero or more MISC records may appear between <MISCS> …
</MISCS>
Returns
|
public
string
|
#
getName( )
Name of the recipe.
Returns
string
|
public
string
|
#
getNotes( )
Notes associated with this recipe – may be multiline.
Notes associated with this recipe – may be multiline.
Returns
string
|
public
float
|
#
getOg( )
The measured original (pre-fermentation) specific gravity of the beer.
The measured original (pre-fermentation) specific gravity of the beer.
Returns
float
Specific Gravity
|
public
number
|
#
getPrimaryAge( )
Time spent in the primary in days
Time spent in the primary in days
Returns
number
Time (days)
|
public
number
|
#
getPrimaryTemp( )
Temperature in degrees Celsius for the primary fermentation.
Temperature in degrees Celsius for the primary fermentation.
Returns
number
Temperature C
|
public
float
|
#
getPrimingSugarEquiv( )
Factor used to convert this priming agent to an equivalent amount of corn
sugar for a bottled scenario.
Factor used to convert this priming agent to an equivalent amount of corn
sugar for a bottled scenario.
For example, "Dry Malt Extract" would have a value of 1.4 because it requires
1.4 times as much DME as corn sugar to carbonate. To calculate the amount of DME
needed, the program can calculate the amount of corn sugar needed and then
multiply by this factor.
Returns
float
|
public
string
|
#
getPrimingSugarName( )
Text describing the priming agent such as "Honey" or "Corn Sugar" – used
only if this is not a forced carbonation
Text describing the priming agent such as "Honey" or "Corn Sugar" – used
only if this is not a forced carbonation
Returns
string
|
public
number
|
#
getSecondaryAge( )
Time spent in the secondary in days
Time spent in the secondary in days
Returns
number
Time (days)
|
public
number
|
#
getSecondaryTemp( )
Temperature in degrees Celsius for the secondary fermentation.
Temperature in degrees Celsius for the secondary fermentation.
Returns
number
Temperature (C )
|
public
BeerXML\Record\Style
|
#
getStyle( )
The style of the beer this recipe is associated with. All of the required
items for a valid style should be between the <STYLE>…</STYLE>
tags.
The style of the beer this recipe is associated with. All of the required
items for a valid style should be between the <STYLE>…</STYLE>
tags.
Returns
|
public
string
|
#
getTasteNotes( )
Tasting notes – may be multiline.
Tasting notes – may be multiline.
Returns
string
|
public
float
|
#
getTasteRating( )
Number between zero and 50.0 denoting the taste rating – corresponds to the
50 point BJCP rating system.
Number between zero and 50.0 denoting the taste rating – corresponds to the
50 point BJCP rating system.
Returns
float
|
public
number
|
#
getTertiaryAge( )
Time spent in the third fermenter in days.
Time spent in the third fermenter in days.
Returns
number
Time (days)
|
public
number
|
#
getTertiaryTemp( )
Temperature in the tertiary fermenter.
Temperature in the tertiary fermenter.
Returns
number
Temperature C
|
public
string
|
#
getType( )
May be one of "Extract", "Partial Mash" or "All Grain"
May be one of "Extract", "Partial Mash" or "All Grain"
Returns
string
|
public
integer
|
#
getVersion( )
Version of the recipe record. Should always be "1" for this version of the
XML standard.
Version of the recipe record. Should always be "1" for this version of the
XML standard.
Returns
integer
|
public
BeerXML\Generator\IWater[]
|
#
getWaters( )
Zero or more WATER records may appear between <WATERS> …
</WATERS>
Zero or more WATER records may appear between <WATERS> …
</WATERS>
Returns
|
public
BeerXML\Generator\IYeast[]
|
#
getYeasts( )
Zero or more YEAST records may appear between <YEASTS> …
</YEASTS>
Zero or more YEAST records may appear between <YEASTS> …
</YEASTS>
Returns
|