This class is the base of all XML-configurable ARGoS interface. More...

#include <base_configurable_resource.h>

Inheritance diagram for argos::CBaseConfigurableResource:

Public Member Functions
virtual	~CBaseConfigurableResource ()
	Class destructor.

virtual void	Init (TConfigurationNode &t_tree)=0
	Initializes the resource.

virtual void	Reset ()=0
	Resets the resource.

virtual void	Destroy ()=0
	Undoes whatever was done by Init().

Detailed Description

This class is the base of all XML-configurable ARGoS interface.

Definition at line 23 of file base_configurable_resource.h.

Constructor & Destructor Documentation

◆ ~CBaseConfigurableResource()

virtual argos::CBaseConfigurableResource::~CBaseConfigurableResource ( )

inlinevirtual

Class destructor.

Definition at line 30 of file base_configurable_resource.h.

Member Function Documentation

◆ Destroy()

virtual void argos::CBaseConfigurableResource::Destroy ( )

pure virtual

Undoes whatever was done by Init().

Implemented in argos::CBatteryDischargeModel, argos::CCI_Actuator, argos::CCI_CameraSensorAlgorithm, argos::CCI_Controller, argos::CCI_Sensor, argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, argos::CControllableEntity, argos::CDefaultVisualization, argos::CDirectionalLEDEntity, argos::CDirectionalLEDMedium, argos::CDynamics2DEngine, argos::CDynamics3DEngine, argos::CEntity, argos::CEPuckEntity, argos::CGrid< ENTITY >, argos::CGrid< argos::CDirectionalLEDEntity >, argos::CGrid< argos::CEmbodiedEntity >, argos::CGrid< argos::CLEDEntity >, argos::CGrid< argos::CRABEquippedEntity >, argos::CGrid< argos::CRadioEntity >, argos::CGrid< argos::CTagEntity >, argos::CLEDEntity, argos::CLEDMedium, argos::CLEDsDefaultActuator, argos::CLoopFunctions, argos::CLuaController, argos::CMedium, argos::CPhysicsEngine, argos::CPointMass3DEngine, argos::CPositionalIndex< ENTITY >, argos::CPositionalIndex< argos::CDirectionalLEDEntity >, argos::CPositionalIndex< argos::CEmbodiedEntity >, argos::CPositionalIndex< argos::CLEDEntity >, argos::CPositionalIndex< argos::CRABEquippedEntity >, argos::CPositionalIndex< argos::CRadioEntity >, argos::CPositionalIndex< argos::CTagEntity >, argos::CPositionalIndex< Element >, argos::CQTOpenGLRender, argos::CQTOpenGLUserFunctions, argos::CRABMedium, argos::CRadioEntity, argos::CRadioMedium, argos::CRangeAndBearingMediumSensor, argos::CSpace, argos::CSpaceMultiThreadBalanceLength, argos::CSpaceMultiThreadBalanceQuantity, argos::CTagEntity, argos::CTagMedium, and argos::CVisualization.

◆ Init()

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

pure virtual

Initializes the resource.

Parameters

t_tree the base of the XML configuration tree to parse

Exceptions

CARGoSException if an error occurs

Implemented in argos::CBatteryDefaultSensor, argos::CBatteryDischargeModel, argos::CBatteryDischargeModelMotion, argos::CBatteryDischargeModelTime, argos::CBatteryDischargeModelTimeMotion, argos::CBatteryEquippedEntity, argos::CBoxEntity, argos::CCameraDefaultSensor, argos::CCameraSensorDirectionalLEDDetectorAlgorithm, argos::CCameraSensorLEDDetectorAlgorithm, argos::CCameraSensorTagDetectorAlgorithm, argos::CCI_Actuator, argos::CCI_CameraSensorAlgorithm, argos::CCI_Controller, argos::CCI_Sensor, argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, argos::CControllableEntity, argos::CCylinderEntity, argos::CDefaultVisualization, argos::CDifferentialSteeringDefaultActuator, argos::CDifferentialSteeringDefaultSensor, argos::CDirectionalLEDEntity, argos::CDirectionalLEDEquippedEntity, argos::CDirectionalLEDMedium, argos::CDirectionalLEDsDefaultActuator, argos::CDynamics2DEngine, argos::CDynamics3DEngine, argos::CEmbodiedEntity, argos::CEntity, argos::CEPuckEntity, argos::CEPuckProximityDefaultSensor, argos::CEyeBotEntity, argos::CEyeBotLightRotZOnlySensor, argos::CEyeBotProximityDefaultSensor, argos::CFloorEntity, argos::CFootBotBaseGroundRotZOnlySensor, argos::CFootBotDistanceScannerRotZOnlySensor, argos::CFootBotEntity, argos::CFootBotLightRotZOnlySensor, argos::CFootBotMotorGroundRotZOnlySensor, argos::CFootBotProximityDefaultSensor, argos::CFootBotTurretEntity, argos::CGrid< ENTITY >, argos::CGrid< argos::CDirectionalLEDEntity >, argos::CGrid< argos::CEmbodiedEntity >, argos::CGrid< argos::CLEDEntity >, argos::CGrid< argos::CRABEquippedEntity >, argos::CGrid< argos::CRadioEntity >, argos::CGrid< argos::CTagEntity >, argos::CGripperEquippedEntity, argos::CGroundRotZOnlySensor, argos::CGroundSensorEquippedEntity, argos::CLEDEntity, argos::CLEDEquippedEntity, argos::CLEDMedium, argos::CLEDsDefaultActuator, argos::CLightDefaultSensor, argos::CLightEntity, argos::CLightSensorEquippedEntity, argos::CLoopFunctions, argos::CLuaController, argos::CMagnetEntity, argos::CMagnetEquippedEntity, argos::CMagnetsDefaultActuator, argos::CMedium, argos::CMiniQuadrotorEntity, argos::CMiniQuadrotorRotorDefaultActuator, argos::COmnidirectionalCameraEquippedEntity, argos::CPerspectiveCameraEquippedEntity, argos::CPhysicsEngine, argos::CPointMass3DEngine, argos::CPositionalEntity, argos::CPositionalIndex< ENTITY >, argos::CPositionalIndex< argos::CDirectionalLEDEntity >, argos::CPositionalIndex< argos::CEmbodiedEntity >, argos::CPositionalIndex< argos::CLEDEntity >, argos::CPositionalIndex< argos::CRABEquippedEntity >, argos::CPositionalIndex< argos::CRadioEntity >, argos::CPositionalIndex< argos::CTagEntity >, argos::CPositionalIndex< Element >, argos::CPositioningDefaultSensor, argos::CPrototypeEntity, argos::CPrototypeJointEntity, argos::CPrototypeJointEquippedEntity, argos::CPrototypeJointsDefaultActuator, argos::CPrototypeJointsDefaultSensor, argos::CPrototypeLinkEntity, argos::CPrototypeLinkEquippedEntity, argos::CProximityDefaultSensor, argos::CProximitySensorEquippedEntity, argos::CQTOpenGLRender, argos::CQTOpenGLUserFunctions, argos::CQuadRotorPositionDefaultActuator, argos::CQuadRotorSpeedDefaultActuator, argos::CRABEquippedEntity, argos::CRABMedium, argos::CRadioEntity, argos::CRadioEquippedEntity, argos::CRadioMedium, argos::CRadiosDefaultActuator, argos::CRadiosDefaultSensor, argos::CRangeAndBearingMediumSensor, argos::CSpace, argos::CSpaceMultiThreadBalanceLength, argos::CSpaceMultiThreadBalanceQuantity, argos::CSpiriEntity, argos::CTagEntity, argos::CTagEquippedEntity, argos::CTagMedium, argos::CTagsDefaultActuator, and argos::CVisualization.

◆ Reset()

virtual void argos::CBaseConfigurableResource::Reset ( )

pure virtual

Resets the resource.

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

core/utility/configuration/base_configurable_resource.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~CBaseConfigurableResource()

Member Function Documentation

◆ Destroy()

◆ Init()

◆ Reset()