VEE_RateControl Class Reference

#include <vee_rate_control.h>

Inheritance diagram for VEE_RateControl:

[legend]Collaboration diagram for VEE_RateControl:

[legend]List of all members.

Public Member Functions

• VEE_RateControl ()
• virtual ~VEE_RateControl ()
• void defaults ()
• virtual void operate (VEE_Object *, float)

  Operates on an object - MUST BE OVERRIDDEN.
  

• virtual VEE_Operator * clone () const

  Clones this object - MUST BE OVERRIDDEN.
  

• void setId (const char *id)
• void setRadius (float r)
• void setHeat (float h)
• void setHeatCoeff (float c)
• void setRequireHeat (float r)
• void setMaxRate (float r)
• void dieAfter (float d)

Protected Attributes

• std::string m_param
• float m_rateIntegral
• float m_dieAfter
• float m_rateToHeat
• float m_currentRate
• float m_maxRate
• float m_maxHeat
• float m_requireHeat
• float m_heatCoeff
• float m_heat
• float m_radius

---

Constructor & Destructor Documentation

VEE_RateControl::VEE_RateControl (   )

VEE_RateControl::~VEE_RateControl (   )  [virtual]

---

Member Function Documentation

void VEE_RateControl::defaults (   )

void VEE_RateControl::operate (  VEE_Object *  , float  )  [virtual]

Operates on an object - MUST BE OVERRIDDEN. Reimplemented from VEE_Operator.

VEE_Operator * VEE_RateControl::clone (   )  const [virtual]

Clones this object - MUST BE OVERRIDDEN. Reimplemented from VEE_Operator.

void VEE_RateControl::setId (  const char *  id  )  [inline]

void VEE_RateControl::setRadius (  float  r  )  [inline]

void VEE_RateControl::setHeat (  float  h  )  [inline]

void VEE_RateControl::setHeatCoeff (  float  c  )  [inline]

void VEE_RateControl::setRequireHeat (  float  r  )  [inline]

void VEE_RateControl::setMaxRate (  float  r  )  [inline]

void VEE_RateControl::dieAfter (  float  d  )  [inline]

---

Member Data Documentation

std::string VEE_RateControl::m_param [protected]

float VEE_RateControl::m_rateIntegral [protected]

float VEE_RateControl::m_dieAfter [protected]

float VEE_RateControl::m_rateToHeat [protected]

float VEE_RateControl::m_currentRate [protected]

float VEE_RateControl::m_maxRate [protected]

float VEE_RateControl::m_maxHeat [protected]

float VEE_RateControl::m_requireHeat [protected]

float VEE_RateControl::m_heatCoeff [protected]

float VEE_RateControl::m_heat [protected]

float VEE_RateControl::m_radius [protected]

---

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

• vee_rate_control.h
• vee_rate_control.C

---