1: <?php
  2: 
  3: 
  4: namespace BeerXML\Generator;
  5: 
  6: 
  7: interface IEquipment
  8: {
  9: 
 10:     /**
 11:      * The target volume of the batch at the start of fermentation.
 12:      *
 13:      * @return float
 14:      */
 15:     public function getBatchSize();
 16: 
 17:     /**
 18:      * The pre-boil volume used in this particular instance for this equipment setup.  Note that this may be a
 19:      * calculated value depending on the CALC_BOIL_VOLUME parameter.
 20:      *
 21:      * @return float
 22:      */
 23:     public function getBoilSize();
 24: 
 25:     /**
 26:      * The normal amount of time one boils for this equipment setup.  This can be used with the evaporation rate to
 27:      * calculate the evaporation loss.
 28:      *
 29:      * @return number
 30:      */
 31:     public function getBoilTime();
 32: 
 33:     /**
 34:      * Flag denoting that the program should calculate the boil size.  Flag may be TRUE or FALSE.
 35:      * If TRUE, then BOIL_SIZE = (BATCH_SIZE – TOP_UP_WATER – TRUB_CHILLER_LOSS) * (1+BOIL_TIME * EVAP_RATE )
 36:      * If set then the boil size should match this value.
 37:      *
 38:      * @return boolean
 39:      */
 40:     public function getCalcBoilVolume();
 41: 
 42:     /**
 43:      * The percentage of wort lost to evaporation per hour of the boil.
 44:      *
 45:      * @return float
 46:      */
 47:     public function getEvapRate();
 48: 
 49:     /**
 50:      * Large batch hop utilization.  This value should be 100% for batches less than 20 gallons, but may be higher
 51:      * (200% or more) for very large batch equipment.
 52:      *
 53:      * @return float
 54:      */
 55:     public function getHopUtilization();
 56: 
 57:     /**
 58:      * Amount lost to the lauter tun and equipment associated with the lautering process.
 59:      *
 60:      * @return number
 61:      */
 62:     public function getLauterDeadspace();
 63: 
 64:     /**
 65:      * Name of the equipment profile – usually a text description of the brewing setup.
 66:      *
 67:      * @return string
 68:      */
 69:     public function getName();
 70: 
 71:     /**
 72:      * Notes associated with the equipment.  May be a multiline entry.
 73:      *
 74:      * @return string
 75:      */
 76:     public function getNotes();
 77: 
 78:     /**
 79:      * Amount normally added to the boil kettle before the boil.
 80:      *
 81:      * @return number
 82:      */
 83:     public function getTopUpKettle();
 84: 
 85:     /**
 86:      * @return float
 87:      */
 88:     public function getTopUpWater();
 89: 
 90:     /**
 91:      * The amount of wort normally lost during transition from the boiler to the fermentation vessel.  Includes both
 92:      * unusable wort due to trub and wort lost to the chiller and transfer systems.
 93:      *
 94:      * @return float
 95:      */
 96:     public function getTrubChillerLoss();
 97: 
 98:     /**
 99:      * The specific heat of the mash tun which is usually a function of the material it is made of.  Typical ranges are
100:      * 0.1-0.25 for metal and 0.2-0.5 for plastic materials.
101:      *
102:      * @return float
103:      */
104:     public function getTunSpecificHeat();
105: 
106:     /**
107:      * Volume of the mash tun in liters.  This parameter can be used to calculate if a particular mash and grain profile
108:      * will fit in the mash tun.  It may also be used for thermal calculations in the case of a partially full mash tun.
109:      *
110:      * @return float
111:      */
112:     public function getTunVolume();
113: 
114:     /**
115:      * Weight of the mash tun in kilograms.  Used primarily to calculate the thermal parameters of the mash tun – in
116:      * conjunction with the volume and specific heat.
117:      *
118:      * @return float
119:      */
120:     public function getTunWeight();
121: 
122:     /**
123:      * Version of the equipment record.  Should always be "1" for this version of the XML standard.
124:      *
125:      * @return int
126:      */
127:     public function getVersion();
128: }