Class Water

BeerXML\Record\Water implements BeerXML\Generator\IWaterDisplay, BeerXML\Parser\IWaterDisplay

Namespace: BeerXML\Record
Located at BeerXML/Record/Water.php

Methods summary
`public`	# `setAmount( number $amount )` Volume of water to use in a recipe in liters. Volume of water to use in a recipe in liters. Parameters `$amount` `number` $amount Implementation of `BeerXML\Parser\IWater::setAmount()`
`public number`	# `getAmount( )` Volume of water to use in a recipe in liters. Volume of water to use in a recipe in liters. Returns `number` Implementation of `BeerXML\Generator\IWater::getAmount()`
`public`	# `setBicarbonate( float $bicarbonate )` The amount of bicarbonate (HCO3) in parts per million. The amount of bicarbonate (HCO3) in parts per million. Parameters `$bicarbonate` `float` $bicarbonate Implementation of `BeerXML\Parser\IWater::setBicarbonate()`
`public float`	# `getBicarbonate( )` The amount of bicarbonate (HCO3) in parts per million. The amount of bicarbonate (HCO3) in parts per million. Returns `float` Implementation of `BeerXML\Generator\IWater::getBicarbonate()`
`public`	# `setCalcium( float $calcium )` The amount of calcium (Ca) in parts per million. The amount of calcium (Ca) in parts per million. Parameters `$calcium` `float` $calcium Implementation of `BeerXML\Parser\IWater::setCalcium()`
`public float`	# `getCalcium( )` The amount of calcium (Ca) in parts per million. The amount of calcium (Ca) in parts per million. Returns `float` Implementation of `BeerXML\Generator\IWater::getCalcium()`
`public`	# `setChloride( float $chloride )` Parameters `$chloride` `float` $chloride Implementation of `BeerXML\Parser\IWater::setChloride()`
`public float`	# `getChloride( )` Returns `float` Implementation of `BeerXML\Generator\IWater::getChloride()`
`public`	# `setMagnesium( float $magnesium )` The amount of Magnesium (Mg) in parts per million. The amount of Magnesium (Mg) in parts per million. Parameters `$magnesium` `float` $magnesium Implementation of `BeerXML\Parser\IWater::setMagnesium()`
`public float`	# `getMagnesium( )` The amount of Magnesium (Mg) in parts per million. The amount of Magnesium (Mg) in parts per million. Returns `float` Implementation of `BeerXML\Generator\IWater::getMagnesium()`
`public`	# `setName( string $name )` Name of the water profile – usually the city and country of the water profile. Name of the water profile – usually the city and country of the water profile. Parameters `$name` `string` $name Implementation of `BeerXML\Parser\IWater::setName()`
`public string`	# `getName( )` Name of the water profile – usually the city and country of the water profile. Name of the water profile – usually the city and country of the water profile. Returns `string` Implementation of `BeerXML\Generator\IWater::getName()`
`public`	# `setNotes( string $notes )` Notes about the water profile. May be multiline. Notes about the water profile. May be multiline. Parameters `$notes` `string` $notes Implementation of `BeerXML\Parser\IWater::setNotes()`
`public string`	# `getNotes( )` Notes about the water profile. May be multiline. Notes about the water profile. May be multiline. Returns `string` Implementation of `BeerXML\Generator\IWater::getNotes()`
`public`	# `setPH( float $pH )` The PH of the water. The PH of the water. Parameters `$pH` `float` $pH Implementation of `BeerXML\Parser\IWater::setPH()`
`public float`	# `getPH( )` The PH of the water. The PH of the water. Returns `float` Implementation of `BeerXML\Generator\IWater::getPH()`
`public`	# `setSodium( float $sodium )` The amount of Sodium (Na) in parts per million. The amount of Sodium (Na) in parts per million. Parameters `$sodium` `float` $sodium Implementation of `BeerXML\Parser\IWater::setSodium()`
`public float`	# `getSodium( )` The amount of Sodium (Na) in parts per million. The amount of Sodium (Na) in parts per million. Returns `float` Implementation of `BeerXML\Generator\IWater::getSodium()`
`public`	# `setSulfate( float $sulfate )` The amount of Sulfate (SO4) in parts per million. The amount of Sulfate (SO4) in parts per million. Parameters `$sulfate` `float` $sulfate Implementation of `BeerXML\Parser\IWater::setSulfate()`
`public float`	# `getSulfate( )` The amount of Sulfate (SO4) in parts per million. The amount of Sulfate (SO4) in parts per million. Returns `float` Implementation of `BeerXML\Generator\IWater::getSulfate()`
`public`	# `setVersion( integer $version )` Version of the water record. Should always be "1" for this version of the XML standard. Version of the water record. Should always be "1" for this version of the XML standard. Parameters `$version` `integer` $version Implementation of `BeerXML\Parser\IWater::setVersion()`
`public integer`	# `getVersion( )` Version of the water record. Should always be "1" for this version of the XML standard. Version of the water record. Should always be "1" for this version of the XML standard. Returns `integer` Implementation of `BeerXML\Generator\IWater::getVersion()`
`public`	# `setDisplayAmount( string $displayAmount )` The amount of water in this record along with the units formatted for easy display in the current user defined units. For example "5.0 gal" or "20.0 l". The amount of water in this record along with the units formatted for easy display in the current user defined units. For example "5.0 gal" or "20.0 l". Parameters `$displayAmount` `string` $displayAmount Implementation of `BeerXML\Parser\IWaterDisplay::setDisplayAmount()`
`public string`	# `getDisplayAmount( )` The amount of water in this record along with the units formatted for easy display in the current user defined units. For example "5.0 gal" or "20.0 l". The amount of water in this record along with the units formatted for easy display in the current user defined units. For example "5.0 gal" or "20.0 l". Returns `string` Implementation of `BeerXML\Generator\IWaterDisplay::getDisplayAmount()`

Namespaces

Classes

Class Water

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of