Emergency 20 Dokumentation  4.2.0
em5::FireSpecsGroup Class Reference

Fire specs group implementation. More...

#include <FireSpecsGroup.h>

Inheritance diagram for em5::FireSpecsGroup:
em5::SpecsGroup qsf::UniqueInstance< FireSpecsGroup > qsf::ParameterGroup qsf::Pluginable< ParameterGroupManager > qsf::PluginableBase qsf::Object

Public Member Functions

 FireSpecsGroup (SpecsGroupManager *specsGroupManager)
 Constructor. More...
 
virtual ~FireSpecsGroup ()
 Destructor. More...
 
float getFullburnFactor () const
 
void setFullburnFactor (float fullburnFactor)
 
float getCoolingBonus () const
 
void setCoolingBonus (float coolingBonus)
 
float getPowerExtinguisher () const
 
void setPowerExtinguisher (float power)
 
float getPowerHose () const
 
void setPowerHose (float power)
 
float getPowerTLF () const
 
void setPowerTLF (float power)
 
float getPowerDLK () const
 
void setPowerDLK (float power)
 
float getPowerFireboat () const
 
void setPowerFireboat (float power)
 
float getPowerCommandoCar () const
 
void setPowerCommandoCar (float power)
 
float getCoolingExtinguisher () const
 
void setCoolingExtinguisher (float power)
 
float getCoolingHose () const
 
void setCoolingHose (float power)
 
float getCoolingTLF () const
 
void setCoolingTLF (float power)
 
float getCoolingDLK () const
 
void setCoolingDLK (float power)
 
float getCoolingFireboat () const
 
void setCoolingFireboat (float power)
 
float getCoolingCommandoCar () const
 
void setCoolingCommandoCar (float power)
 
float getRangeExtinguisher () const
 
void setRangeExtinguisher (float range)
 
float getRangeHoseMin () const
 
void setRangeHoseMin (float rangeMin)
 
float getRangeHoseMax () const
 
void setRangeHoseMax (float rangeMax)
 
float getRangeTLF () const
 
void setRangeTLF (float range)
 
float getRangeDLK () const
 
void setRangeDLK (float range)
 
float getRangeFireboatMin () const
 
void setRangeFireboatMin (float rangeMin)
 
float getRangeFireboatMax () const
 
void setRangeFireboatMax (float rangeMax)
 
float getRadiusCommandoCarExtinguish () const
 
void setRadiusCommandoCarExtinguish (float radius)
 
float getDurationCommandoCarExtinguish () const
 
void setDurationCommandoCarExtinguish (float duration)
 
float getCooldownCommandoCarExtinguish () const
 
void setCooldownCommandoCarExtinguish (float cooldownTimeInSec)
 
float getCommandoCarExtinguishOffsetPosition () const
 
void setCommandoCarExtinguishOffsetPosition (float meter)
 
float getCommandoCarExtinguishOffsetTime () const
 
void setCommandoCarExtinguishOffsetTime (float time)
 
float getCommandoCarExtinguishStartDelay () const
 
void setCommandoCarExtinguishStartDelay (float time)
 
float getRangeHydrant () const
 
void setRangeHydrant (float range)
 
float getRemoveSuitTime () const
 
void setRemoveSuitTime (float time)
 
float getRemoveMaskTime () const
 
void setRemoveMaskTime (float time)
 
bool getUseGroundHydrants () const
 
void setUseGroundHydrants (bool useGroundHydrants)
 
bool getUseDynamicHydrants () const
 
void setUseDynamicHydrants (bool useDynamicHydrants)
 
- Public Member Functions inherited from em5::SpecsGroup
virtual ~SpecsGroup ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::ParameterGroup
virtual ~ParameterGroup ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::Pluginable< ParameterGroupManager >
virtual ~Pluginable ()
 Destructor. More...
 
ParameterGroupManagergetManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::PluginableBase
virtual ~PluginableBase ()
 Destructor. More...
 
template<typename T >
T & getPluginableManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Static Public Attributes

static const uint32 PLUGINABLE_ID
 "em5::FireSpecsGroup" unique pluginable specs group ID More...
 
static const uint32 FULLBURN_FACTOR
 "FullburnFactor" unique class property ID inside the class More...
 
static const uint32 COOLING_BONUS
 "CoolingBonus" unique class property ID inside the class More...
 
static const uint32 POWER_EXTINGUISHER
 "PowerExtinguisher" unique class property ID inside the class More...
 
static const uint32 POWER_HOSE
 "PowerHose" unique class property ID inside the class More...
 
static const uint32 POWER_TLF
 "PowerTLF" unique class property ID inside the class More...
 
static const uint32 POWER_DLK
 "PowerDLK" unique class property ID inside the class More...
 
static const uint32 POWER_FIREBOAT
 "PowerFireboat" unique class property ID inside the class More...
 
static const uint32 POWER_COMMANDOCAR
 "PowerCommandoCar" unique class property ID inside the class More...
 
static const uint32 COOLING_POWER_EXTINGUISHER
 "CoolingPowerExtinguisher" unique class property ID inside the class More...
 
static const uint32 COOLING_POWER_HOSE
 "CoolingPowerHose" unique class property ID inside the class More...
 
static const uint32 COOLING_POWER_TLF
 "CoolingPowerTLF" unique class property ID inside the class More...
 
static const uint32 COOLING_POWER_DLK
 "CoolingPowerDLK" unique class property ID inside the class More...
 
static const uint32 COOLING_POWER_FIREBOAT
 "CoolingPowerFireboat" unique class property ID inside the class More...
 
static const uint32 COOLING_POWER_COMMANDOCAR
 "CoolingCommandoCar" unique class property ID inside the class More...
 
static const uint32 RANGE_EXTINGUISHER
 "RangeExtinguisher" unique class property ID inside the class More...
 
static const uint32 RANGE_HOSE_MIN
 "RangeHoseMin" unique class property ID inside the class More...
 
static const uint32 RANGE_HOSE_MAX
 "RangeHoseMax" unique class property ID inside the class More...
 
static const uint32 RANGE_TLF
 "RangeTLF" unique class property ID inside the class More...
 
static const uint32 RANGE_DLK
 "RangeDLK" unique class property ID inside the class More...
 
static const uint32 RANGE_FIREBOAT_MIN
 "RangeFireboatMin" unique class property ID inside the class More...
 
static const uint32 RANGE_FIREBOAT_MAX
 "RangeFireboatMax" unique class property ID inside the class More...
 
static const uint32 RADIUS_COMMANDOCAR_EXTINGUISH
 "RadiusCommandoCarExtinguish" unique class property ID inside the class More...
 
static const uint32 DURATION_COMMANDOCAR_EXTINGUISH
 "DurationCommandoCarExtinguish" unique class property ID inside the class More...
 
static const uint32 COOLDOWN_COMMANDOCAR_EXTINGUISH
 "CooldownCommandoCarExtinguish" unique class property ID inside the class More...
 
static const uint32 COMMANDOCAR_EXTINGUISH_EFFECT_OFFSET_POSITION
 "CommandoCarExtinguishEffectOffsetPosition" unique class property ID inside the class More...
 
static const uint32 COMMANDOCAR_EXTINGUISH_EFFECT_OFFSET_TIME
 "CommandoCarExtinguishEffectOffsetTime" unique class property ID inside the class More...
 
static const uint32 COMMANDOCAR_EXTINGUISH_START_DELAY
 "CommandoCarExtinguishStartDelay" unique class property ID inside the class More...
 
static const uint32 RANGE_HYDRANT
 "RangeHydrant" unique class property ID inside the class More...
 
static const uint32 REMOVE_SUIT_TIME
 "RemoveSuitTime" unique class property ID inside the class More...
 
static const uint32 REMOVE_MASK_TIME
 "RemoveMaskTime" unique class property ID inside the class More...
 
static const uint32 USE_GROUNDHYDRANTS
 "UseGroundHydrants" unique class property ID inside the class More...
 
static const uint32 USE_DYNAMICHYDRANTS
 "UseDynamicHydrants" unique class property ID inside the class More...
 

Additional Inherited Members

- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 
- Static Public Member Functions inherited from qsf::UniqueInstance< FireSpecsGroup >
static FireSpecsGroup * getInstance ()
 Return the global unique instance. More...
 
static FireSpecsGroup & getInstanceSafe ()
 Return the global unique instance. More...
 
- Protected Member Functions inherited from em5::SpecsGroup
 SpecsGroup (SpecsGroupManager *specsGroupManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::ParameterGroup
 ParameterGroup (ParameterGroupManager *parameterGroupManager)
 Constructor. More...
 
void promotePropertyChange (uint32 propertyId)
 A component property value was changed. More...
 
template<typename T >
bool assignAndPromoteChange (T &variable, const T &newValue, uint32 propertyId)
 Comfort function for updating an exported member variable and promoting any change that happened. More...
 
- Protected Member Functions inherited from qsf::Pluginable< ParameterGroupManager >
 Pluginable (ParameterGroupManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::PluginableBase
 PluginableBase (PluginableManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::UniqueInstance< FireSpecsGroup >
 UniqueInstance ()
 Default constructor. More...
 
virtual ~UniqueInstance ()
 Destructor. More...
 

Detailed Description

Fire specs group implementation.

Constructor & Destructor Documentation

em5::FireSpecsGroup::FireSpecsGroup ( SpecsGroupManager specsGroupManager)
inlineexplicit

Constructor.

Parameters
[in]specsGroupManagerOptional pointer to the specs group manager this specs group should be registered to, can be a null pointer
em5::FireSpecsGroup::~FireSpecsGroup ( )
inlinevirtual

Destructor.

Member Function Documentation

float em5::FireSpecsGroup::getCommandoCarExtinguishOffsetPosition ( ) const
inline
float em5::FireSpecsGroup::getCommandoCarExtinguishOffsetTime ( ) const
inline
float em5::FireSpecsGroup::getCommandoCarExtinguishStartDelay ( ) const
inline
float em5::FireSpecsGroup::getCooldownCommandoCarExtinguish ( ) const
inline
float em5::FireSpecsGroup::getCoolingBonus ( ) const
inline
float em5::FireSpecsGroup::getCoolingCommandoCar ( ) const
inline
float em5::FireSpecsGroup::getCoolingDLK ( ) const
inline
float em5::FireSpecsGroup::getCoolingExtinguisher ( ) const
inline
float em5::FireSpecsGroup::getCoolingFireboat ( ) const
inline
float em5::FireSpecsGroup::getCoolingHose ( ) const
inline
float em5::FireSpecsGroup::getCoolingTLF ( ) const
inline
float em5::FireSpecsGroup::getDurationCommandoCarExtinguish ( ) const
inline
float em5::FireSpecsGroup::getFullburnFactor ( ) const
inline
float em5::FireSpecsGroup::getPowerCommandoCar ( ) const
inline
float em5::FireSpecsGroup::getPowerDLK ( ) const
inline
float em5::FireSpecsGroup::getPowerExtinguisher ( ) const
inline
float em5::FireSpecsGroup::getPowerFireboat ( ) const
inline
float em5::FireSpecsGroup::getPowerHose ( ) const
inline
float em5::FireSpecsGroup::getPowerTLF ( ) const
inline
float em5::FireSpecsGroup::getRadiusCommandoCarExtinguish ( ) const
inline
float em5::FireSpecsGroup::getRangeDLK ( ) const
inline
float em5::FireSpecsGroup::getRangeExtinguisher ( ) const
inline
float em5::FireSpecsGroup::getRangeFireboatMax ( ) const
inline
float em5::FireSpecsGroup::getRangeFireboatMin ( ) const
inline
float em5::FireSpecsGroup::getRangeHoseMax ( ) const
inline
float em5::FireSpecsGroup::getRangeHoseMin ( ) const
inline
float em5::FireSpecsGroup::getRangeHydrant ( ) const
inline
float em5::FireSpecsGroup::getRangeTLF ( ) const
inline
float em5::FireSpecsGroup::getRemoveMaskTime ( ) const
inline
float em5::FireSpecsGroup::getRemoveSuitTime ( ) const
inline
bool em5::FireSpecsGroup::getUseDynamicHydrants ( ) const
inline
bool em5::FireSpecsGroup::getUseGroundHydrants ( ) const
inline
void em5::FireSpecsGroup::setCommandoCarExtinguishOffsetPosition ( float  meter)
void em5::FireSpecsGroup::setCommandoCarExtinguishOffsetTime ( float  time)
void em5::FireSpecsGroup::setCommandoCarExtinguishStartDelay ( float  time)
void em5::FireSpecsGroup::setCooldownCommandoCarExtinguish ( float  cooldownTimeInSec)
void em5::FireSpecsGroup::setCoolingBonus ( float  coolingBonus)
void em5::FireSpecsGroup::setCoolingCommandoCar ( float  power)
void em5::FireSpecsGroup::setCoolingDLK ( float  power)
void em5::FireSpecsGroup::setCoolingExtinguisher ( float  power)
void em5::FireSpecsGroup::setCoolingFireboat ( float  power)
void em5::FireSpecsGroup::setCoolingHose ( float  power)
void em5::FireSpecsGroup::setCoolingTLF ( float  power)
void em5::FireSpecsGroup::setDurationCommandoCarExtinguish ( float  duration)
void em5::FireSpecsGroup::setFullburnFactor ( float  fullburnFactor)
void em5::FireSpecsGroup::setPowerCommandoCar ( float  power)
void em5::FireSpecsGroup::setPowerDLK ( float  power)
void em5::FireSpecsGroup::setPowerExtinguisher ( float  power)
void em5::FireSpecsGroup::setPowerFireboat ( float  power)
void em5::FireSpecsGroup::setPowerHose ( float  power)
void em5::FireSpecsGroup::setPowerTLF ( float  power)
void em5::FireSpecsGroup::setRadiusCommandoCarExtinguish ( float  radius)
void em5::FireSpecsGroup::setRangeDLK ( float  range)
void em5::FireSpecsGroup::setRangeExtinguisher ( float  range)
void em5::FireSpecsGroup::setRangeFireboatMax ( float  rangeMax)
void em5::FireSpecsGroup::setRangeFireboatMin ( float  rangeMin)
void em5::FireSpecsGroup::setRangeHoseMax ( float  rangeMax)
void em5::FireSpecsGroup::setRangeHoseMin ( float  rangeMin)
void em5::FireSpecsGroup::setRangeHydrant ( float  range)
void em5::FireSpecsGroup::setRangeTLF ( float  range)
void em5::FireSpecsGroup::setRemoveMaskTime ( float  time)
void em5::FireSpecsGroup::setRemoveSuitTime ( float  time)
void em5::FireSpecsGroup::setUseDynamicHydrants ( bool  useDynamicHydrants)
void em5::FireSpecsGroup::setUseGroundHydrants ( bool  useGroundHydrants)

Member Data Documentation

const uint32 em5::FireSpecsGroup::COMMANDOCAR_EXTINGUISH_EFFECT_OFFSET_POSITION
static

"CommandoCarExtinguishEffectOffsetPosition" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COMMANDOCAR_EXTINGUISH_EFFECT_OFFSET_TIME
static

"CommandoCarExtinguishEffectOffsetTime" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COMMANDOCAR_EXTINGUISH_START_DELAY
static

"CommandoCarExtinguishStartDelay" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLDOWN_COMMANDOCAR_EXTINGUISH
static

"CooldownCommandoCarExtinguish" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLING_BONUS
static

"CoolingBonus" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLING_POWER_COMMANDOCAR
static

"CoolingCommandoCar" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLING_POWER_DLK
static

"CoolingPowerDLK" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLING_POWER_EXTINGUISHER
static

"CoolingPowerExtinguisher" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLING_POWER_FIREBOAT
static

"CoolingPowerFireboat" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLING_POWER_HOSE
static

"CoolingPowerHose" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::COOLING_POWER_TLF
static

"CoolingPowerTLF" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::DURATION_COMMANDOCAR_EXTINGUISH
static

"DurationCommandoCarExtinguish" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::FULLBURN_FACTOR
static

"FullburnFactor" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::PLUGINABLE_ID
static

"em5::FireSpecsGroup" unique pluginable specs group ID

const uint32 em5::FireSpecsGroup::POWER_COMMANDOCAR
static

"PowerCommandoCar" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::POWER_DLK
static

"PowerDLK" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::POWER_EXTINGUISHER
static

"PowerExtinguisher" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::POWER_FIREBOAT
static

"PowerFireboat" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::POWER_HOSE
static

"PowerHose" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::POWER_TLF
static

"PowerTLF" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RADIUS_COMMANDOCAR_EXTINGUISH
static

"RadiusCommandoCarExtinguish" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_DLK
static

"RangeDLK" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_EXTINGUISHER
static

"RangeExtinguisher" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_FIREBOAT_MAX
static

"RangeFireboatMax" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_FIREBOAT_MIN
static

"RangeFireboatMin" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_HOSE_MAX
static

"RangeHoseMax" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_HOSE_MIN
static

"RangeHoseMin" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_HYDRANT
static

"RangeHydrant" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::RANGE_TLF
static

"RangeTLF" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::REMOVE_MASK_TIME
static

"RemoveMaskTime" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::REMOVE_SUIT_TIME
static

"RemoveSuitTime" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::USE_DYNAMICHYDRANTS
static

"UseDynamicHydrants" unique class property ID inside the class

const uint32 em5::FireSpecsGroup::USE_GROUNDHYDRANTS
static

"UseGroundHydrants" unique class property ID inside the class


The documentation for this class was generated from the following files: