argos::CBatteryDischargeModel Class Referenceabstract

The discharge model dictates how the battery discharges over time. More...

#include <battery_equipped_entity.h>

Inheritance diagram for argos::CBatteryDischargeModel:
Collaboration diagram for argos::CBatteryDischargeModel:

Public Member Functions

 CBatteryDischargeModel ()
 
virtual ~CBatteryDischargeModel ()
 
virtual void Init (TConfigurationNode &t_tree)
 Initializes the resource. More...
 
virtual void Reset ()
 Resets the resource. More...
 
virtual void Destroy ()
 Undoes whatever was done by Init(). More...
 
virtual void SetBattery (CBatteryEquippedEntity *pc_battery)
 
virtual void operator() ()=0
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Protected Attributes

CBatteryEquippedEntitym_pcBattery
 

Detailed Description

The discharge model dictates how the battery discharges over time.

Definition at line 102 of file battery_equipped_entity.h.

Constructor & Destructor Documentation

argos::CBatteryDischargeModel::CBatteryDischargeModel ( )

Definition at line 118 of file battery_equipped_entity.cpp.

argos::CBatteryDischargeModel::~CBatteryDischargeModel ( )
virtual

Definition at line 125 of file battery_equipped_entity.cpp.

Member Function Documentation

virtual void argos::CBatteryDischargeModel::Destroy ( )
inlinevirtual

Undoes whatever was done by Init().

Implements argos::CBaseConfigurableResource.

Definition at line 114 of file battery_equipped_entity.h.

virtual void argos::CBatteryDischargeModel::Init ( TConfigurationNode t_tree)
inlinevirtual

Initializes the resource.

Parameters
t_treethe base of the XML configuration tree to parse
Exceptions
CARGoSExceptionif an error occurs

Implements argos::CBaseConfigurableResource.

Reimplemented in argos::CBatteryDischargeModelTimeMotion, argos::CBatteryDischargeModelMotion, and argos::CBatteryDischargeModelTime.

Definition at line 110 of file battery_equipped_entity.h.

virtual void argos::CBatteryDischargeModel::operator() ( )
pure virtual
virtual void argos::CBatteryDischargeModel::Reset ( )
inlinevirtual

Resets the resource.

Implements argos::CBaseConfigurableResource.

Definition at line 112 of file battery_equipped_entity.h.

void argos::CBatteryDischargeModel::SetBattery ( CBatteryEquippedEntity pc_battery)
virtual

Member Data Documentation

CBatteryEquippedEntity* argos::CBatteryDischargeModel::m_pcBattery
protected

Definition at line 122 of file battery_equipped_entity.h.