magnet_entity.h

Go to the documentation of this file.

 
#ifndef MAGNET_ENTITY_H
#define MAGNET_ENTITY_H
 
namespace argos {
   class CMagnetEntity;
}
 
#include <argos3/core/simulator/entity/entity.h>
#include <argos3/core/utility/math/vector3.h>
 
namespace argos {
 
   class CMagnetEntity : public CEntity {
 
   public:
 
      ENABLE_VTABLE();
 
   public:
 
      CMagnetEntity(CComposableEntity* pc_parent);
 
      CMagnetEntity(CComposableEntity* pc_parent,
                    const std::string& str_id,
                    const CVector3& c_passive_field,
                    const CVector3& c_active_field);
 
      virtual ~CMagnetEntity() {}
 
      virtual void Init(TConfigurationNode& t_tree);
 
      virtual void Reset();
 
      inline const CVector3& GetField() const {
         return m_cField;
      }
 
      inline const CVector3& GetPassiveField() const {
         return m_cPassiveField;
      }
 
      inline const CVector3& GetActiveField() const {
         return m_cActiveField;
      }
 
      inline void SetCurrent(Real f_current) {
         m_cField = m_cPassiveField + m_cActiveField * f_current;
      }
 
      virtual std::string GetTypeDescription() const {
         return "magnet";
      }
 
   protected:
 
      CVector3 m_cField;
      CVector3 m_cPassiveField;
      CVector3 m_cActiveField;
 
   };
 
   /****************************************/
   /****************************************/
 
}
 
#endif