argos::CBatteryDischargeModel Class Reference

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

#include <battery_equipped_entity.h>

Inheritance diagram for argos::CBatteryDischargeModel:

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

Protected Attributes
CBatteryEquippedEntity *	m_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

CBatteryDischargeModel()

argos::CBatteryDischargeModel::CBatteryDischargeModel

(

)

Definition at line 121 of file battery_equipped_entity.cpp.

~CBatteryDischargeModel()

argos::CBatteryDischargeModel::~CBatteryDischargeModel ( )

virtual

Definition at line 128 of file battery_equipped_entity.cpp.

Member Function Documentation

Destroy()

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.

Init()

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

inlinevirtual

Initializes the resource.

Parameters

t_tree

the base of the XML configuration tree to parse

Exceptions

CARGoSException

if an error occurs

Implements argos::CBaseConfigurableResource.

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

Definition at line 110 of file battery_equipped_entity.h.

operator()()

virtual void argos::CBatteryDischargeModel::operator() ( )

pure virtual

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

Reset()

virtual void argos::CBatteryDischargeModel::Reset ( )

inlinevirtual

Resets the resource.

Implements argos::CBaseConfigurableResource.

Definition at line 112 of file battery_equipped_entity.h.

SetBattery()

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

virtual

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

Definition at line 134 of file battery_equipped_entity.cpp.

Member Data Documentation

m_pcBattery

CBatteryEquippedEntity* argos::CBatteryDischargeModel::m_pcBattery

protected

Definition at line 122 of file battery_equipped_entity.h.

---

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

• plugins/simulator/entities/battery_equipped_entity.h
• plugins/simulator/entities/battery_equipped_entity.cpp