argos::CBaseConfigurableResource Class Referenceabstract

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. More...
 
virtual void Init (TConfigurationNode &t_tree)=0
 Initializes the resource. More...
 
virtual void Reset ()=0
 Resets the resource. More...
 
virtual void Destroy ()=0
 Undoes whatever was done by Init(). More...
 

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

virtual argos::CBaseConfigurableResource::~CBaseConfigurableResource ( )
inlinevirtual

Class destructor.

Definition at line 30 of file base_configurable_resource.h.

Member Function Documentation

virtual void argos::CBaseConfigurableResource::Destroy ( )
pure virtual

Undoes whatever was done by Init().

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

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

Initializes the resource.

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

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

virtual void argos::CBaseConfigurableResource::Reset ( )
pure virtual

Resets the resource.

Implemented in argos::CEntity, argos::CPhysicsEngine, argos::CBatteryDischargeModel, argos::CSpace, argos::CLoopFunctions, argos::CEmbodiedEntity, argos::CFloorEntity, argos::CQTOpenGLUserFunctions, argos::CControllableEntity, argos::CLEDEquippedEntity, argos::CGripperEquippedEntity, argos::CPositionalIndex< ENTITY >, argos::CPositionalIndex< argos::CLEDEntity >, argos::CPositionalIndex< Element >, argos::CPositionalIndex< argos::CTagEntity >, argos::CPositionalIndex< argos::CEmbodiedEntity >, argos::CPositionalIndex< argos::CRadioEntity >, argos::CPositionalIndex< argos::CDirectionalLEDEntity >, argos::CPositionalIndex< argos::CRABEquippedEntity >, argos::CComposableEntity, argos::CCI_Controller, argos::CDifferentialSteeringDefaultActuator, argos::CCI_Actuator, argos::CCI_Sensor, argos::CDynamics2DEngine, argos::CFootBotEntity, argos::CQuadRotorEntity, argos::CRABEquippedEntity, argos::CMiniQuadrotorRotorDefaultActuator, argos::CMedium, argos::CGrid< ENTITY >, argos::CEyeBotEntity, argos::CGrid< argos::CLEDEntity >, argos::CGrid< argos::CTagEntity >, argos::CGrid< argos::CEmbodiedEntity >, argos::CGrid< argos::CRadioEntity >, argos::CGrid< argos::CDirectionalLEDEntity >, argos::CGrid< argos::CRABEquippedEntity >, argos::CDirectionalLEDEntity, argos::CTagEntity, argos::CPrototypeJointsDefaultActuator, argos::CEPuckEntity, argos::CLEDEntity, argos::CRadioEntity, argos::CSpiriEntity, argos::CQTOpenGLRender, argos::CPrototypeJointsDefaultSensor, argos::CFootBotDistanceScannerDefaultActuator, argos::CFootBotDistanceScannerRotZOnlySensor, argos::CFootBotTurretEntity, argos::CQuadRotorPositionDefaultActuator, argos::CFootBotBaseGroundRotZOnlySensor, argos::CFootBotMotorGroundRotZOnlySensor, argos::CBatteryDefaultSensor, argos::CGroundRotZOnlySensor, argos::CEyeBotLightRotZOnlySensor, argos::CFootBotLightRotZOnlySensor, argos::CDifferentialSteeringDefaultSensor, argos::CLightDefaultSensor, argos::CPositioningDefaultSensor, argos::CProximityDefaultSensor, argos::CQuadRotorSpeedDefaultActuator, argos::CCylinderEntity, argos::CFootBotTurretDefaultActuator, argos::CDirectionalLEDsDefaultActuator, argos::CDirectionalLEDMedium, argos::CRadioMedium, argos::CTagMedium, argos::CDynamics3DEngine, argos::CFootBotDistanceScannerEquippedEntity, argos::CCI_CameraSensorAlgorithm, argos::CMagnetEntity, argos::CEyeBotProximityDefaultSensor, argos::CFootBotProximityDefaultSensor, argos::CFootBotTurretEncoderDefaultSensor, argos::CLEDsDefaultActuator, argos::CRangeAndBearingMediumSensor, argos::CVisualization, argos::CBoxEntity, argos::CFootBotGripperDefaultActuator, argos::CGripperDefaultActuator, argos::CMagnetsDefaultActuator, argos::CRadiosDefaultActuator, argos::CRadiosDefaultSensor, argos::CPositionalEntity, argos::CColoredBlobOmnidirectionalCameraRotZOnlySensor, argos::CColoredBlobPerspectiveCameraDefaultSensor, argos::CRangeAndBearingDefaultActuator, argos::CRotorEquippedEntity, argos::CWheeledEntity, argos::CRABMedium, argos::CDefaultVisualization, argos::CLEDMedium, argos::CPointMass3DEngine, and argos::CLuaController.