8 #include <argos3/plugins/simulator/entities/magnet_equipped_entity.h>
16 m_pcMagnetEquippedEntity(nullptr) {
69 s_interface.Current = 0.0f;
78 "Michael Allwright [allsey87@gmail.com]",
80 "The (electro)magnet actuator.",
81 "This actuator is used to modify the magnetic field of a magnet entity in the\n"
82 "simulation. A magnetic entity has a passive and an active field. The overall\n"
83 "field of a magnetic entity is calculated as:\n\n"
84 " field = passive_field + (current x active_field)\n\n"
85 "This actuator allows you to set the current, a scalar multiplier of the active\n"
87 "REQUIRED XML CONFIGURATION\n\n"
90 " <my_controller ...>\n"
94 " <magnets implementation=\"default\"/>\n"
100 " </controllers>\n\n"
101 "OPTIONAL XML CONFIGURATION\n\n"
void SetCurrent(Real f_current)
Sets the current field of the magnet.
virtual void Update()
Updates the state of the entity associated to this actuator.
REGISTER_ACTUATOR(CFootBotDistanceScannerDefaultActuator,"footbot_distance_scanner","default","Carlo Pinciroli [ilpincy@gmail.com]","1.0","The foot-bot distance scanner actuator.","This actuator controls the foot-bot distance scanner. For a complete\n""description of its usage, refer to the ci_footbot_distance_scanner_actuator\n""file.\n\n""REQUIRED XML CONFIGURATION\n\n"" <controllers>\n"" ...\n"" <my_controller ...>\n"" ...\n"" <actuators>\n"" ...\n"" <footbot_distance_scanner implementation=\"default\" />\n"" ...\n"" </actuators>\n"" ...\n"" </my_controller>\n"" ...\n"" </controllers>\n\n""OPTIONAL XML CONFIGURATION\n\n""None for the time being.\n","Usable")
CMagnetEquippedEntity * m_pcMagnetEquippedEntity
ticpp::Element TConfigurationNode
The ARGoS configuration XML node.
#define THROW_ARGOSEXCEPTION_NESTED(message, nested)
This macro throws an ARGoS exception with the passed message and nesting the passed exception...
virtual void Init(TConfigurationNode &t_tree)
Initializes the actuator from the XML configuration tree.
virtual void Init(TConfigurationNode &t_node)
Initializes the actuator from the XML configuration tree.
SInterface::TVector m_vecInterfaces
Basic class for an entity that contains other entities.
CMagnetEntity & GetMagnet(UInt32 un_index)
Returns an magnet by numeric index.
CMagnetsDefaultActuator()
virtual void SetRobot(CComposableEntity &c_entity)
Sets the entity associated to this actuator.
The exception that wraps all errors in ARGoS.
virtual void Reset()
Resets the actuator to the state it had just after Init().
A container of CMagnetEntity.
The namespace containing all the ARGoS related code.
SInstance::TVector & GetInstances()
CEntity & GetComponent(const std::string &str_component)
Returns the component with the passed string label.