#include <magnets_default_actuator.h>

Inheritance diagram for argos::CMagnetsDefaultActuator:

[legend]

Collaboration diagram for argos::CMagnetsDefaultActuator:

[legend]

Public Member Functions
	CMagnetsDefaultActuator ()

virtual	~CMagnetsDefaultActuator ()

virtual void	SetRobot (CComposableEntity &c_entity)
	Sets the entity associated to this actuator. More...

virtual void	Init (TConfigurationNode &t_tree)
	Initializes the actuator from the XML configuration tree. More...

virtual void	Update ()
	Updates the state of the entity associated to this actuator. More...

virtual void	Reset ()
	Resets the actuator to the state it had just after Init(). More...

Public Member Functions inherited from argos::CSimulatedActuator
virtual	~CSimulatedActuator ()
	Class destructor. More...

Public Member Functions inherited from argos::CCI_MagnetsActuator
	CCI_MagnetsActuator ()
	Constructor. More...

virtual	~CCI_MagnetsActuator ()
	Destructor. More...

SInterface::TVector &	GetInterfaces ()
	Returns a reference to the magnet interfaces. More...

Public Member Functions inherited from argos::CCI_Actuator
virtual	~CCI_Actuator ()
	Class destructor. More...

virtual void	Destroy ()
	Destroys the actuator. More...

Public Member Functions inherited from argos::CBaseConfigurableResource
virtual	~CBaseConfigurableResource ()
	Class destructor. More...

Protected Attributes
CMagnetEquippedEntity *	m_pcMagnetEquippedEntity

Protected Attributes inherited from argos::CCI_MagnetsActuator
SInterface::TVector	m_vecInterfaces

Additional Inherited Members
Public Types inherited from argos::CCI_Actuator
typedef std::map< std::string, CCI_Actuator *, std::less< std::string > >	TMap

Detailed Description

Definition at line 20 of file magnets_default_actuator.h.

Constructor & Destructor Documentation

◆ CMagnetsDefaultActuator()

argos::CMagnetsDefaultActuator::CMagnetsDefaultActuator ( )

Definition at line 15 of file magnets_default_actuator.cpp.

◆ ~CMagnetsDefaultActuator()

virtual argos::CMagnetsDefaultActuator::~CMagnetsDefaultActuator ( )

inlinevirtual

Definition at line 27 of file magnets_default_actuator.h.

Member Function Documentation

◆ Init()

void argos::CMagnetsDefaultActuator::Init ( TConfigurationNode & t_node )

virtual

Initializes the actuator from the XML configuration tree.

The default implementation of this method does nothing.

Parameters

t_node The XML configuration tree relative to this actuator.

See also: Reset(); Destroy()

Reimplemented from argos::CCI_Actuator.

Definition at line 41 of file magnets_default_actuator.cpp.

◆ Reset()

void argos::CMagnetsDefaultActuator::Reset ( )

virtual

Resets the actuator to the state it had just after Init().

The default implementation of this method does nothing.

See also: Init(); Destroy()

Reimplemented from argos::CCI_Actuator.

Definition at line 66 of file magnets_default_actuator.cpp.

◆ SetRobot()

void argos::CMagnetsDefaultActuator::SetRobot ( CComposableEntity & c_entity )

virtual

Sets the entity associated to this actuator.

When a controller is created, all the sensors and actuators are created, too. This function is called right before the Init() method of the actuator is called.

Parameters

c_entity The entity to associate to this actuator.