magnets_default_actuator.cpp File Reference
#include "magnets_default_actuator.h"
#include <argos3/plugins/simulator/entities/magnet_equipped_entity.h>
Include dependency graph for magnets_default_actuator.cpp:

Go to the source code of this file.

Namespaces

 argos
 The namespace containing all the ARGoS related code.
 

Functions

 argos::REGISTER_ACTUATOR (CMagnetsDefaultActuator, "magnets", "default", "Michael Allwright [allsey87@gmail.com]", "1.0", "The (electro)magnet actuator.", "This actuator is used to modify the magnetic field of a magnet entity in the\n" "simulation. A magnetic entity has a passive and an active field. The overall\n" "field of a magnetic entity is calculated as:\n\n" " field = passive_field + (current x active_field)\n\n" "This actuator allows you to set the current, a scalar multiplier of the active\n" "field.\n\n" "REQUIRED XML CONFIGURATION\n\n" " <controllers>\n" " ...\n" " <my_controller ...>\n" " ...\n" " <actuators>\n" " ...\n" " <magnets implementation=\"default\"/>\n" " ...\n" " </actuators>\n" " ...\n" " </my_controller>\n" " ...\n" " </controllers>\n\n" "OPTIONAL XML CONFIGURATION\n\n" "None.\n", "Under development")