Privacy
An open-source, flexible 3D physical simulation framework
Public Member Functions | List of all members
mars::interfaces::EntityManagerInterface Class Referenceabstract

#include <EntityManagerInterface.h>

Public Member Functions

virtual ~EntityManagerInterface ()
 
virtual const std::map< unsigned long, sim::SimEntity * > * subscribeToEntityCreation (EntitySubscriberInterface *newsub)=0
 
virtual unsigned long addEntity (const std::string &name)=0
 creates a new entity with the given name and returns its id More...
 
virtual unsigned long addEntity (sim::SimEntity *entity)=0
 adds an existing entity to its entity map, returning the assigned id More...
 
virtual void addNode (const std::string &entityName, unsigned long nodeId, const std::string &nodeName)=0
 adds a node to the entity and maps the nodeId to its name More...
 
virtual void addMotor (const std::string &entityName, unsigned long motorId, const std::string &motorName)=0
 adds a motor to the entity and maps the motorId to its name More...
 
virtual void addController (const std::string &entityName, unsigned long controllerId)=0
 adds a controller id to the controller list More...
 
virtual void addJoint (const std::string &entityName, unsigned long jointId, const std::string &jointName)=0
 adds a joint to the entity and maps the jointId to its name More...
 
virtual void selectEvent (unsigned long id, bool mode)=0
 
virtual sim::SimEntity * getEntity (const std::string &name)=0
 returns the entity with the given name More...
 
virtual sim::SimEntity * getEntity (unsigned long id)=0
 returns the entity with the given id More...
 
virtual unsigned long getEntityNode (const std::string &entityName, const std::string &nodeName)=0
 returns the node of the given entity; returns 0 if the entity or the node don't exist More...
 
virtual unsigned long getEntityMotor (const std::string &entityName, const std::string &motorName)=0
 
virtual std::vector< unsigned long > getEntityControllerList (const std::string &entityName)=0
 
virtual unsigned long getEntityJoint (const std::string &entityName, const std::string &jointName)=0
 returns the node of the given entity; returns 0 if the entity or the node don't exist More...
 
virtual void printEntityNodes (const std::string &entityName)=0
 
virtual void printEntityMotors (const std::string &entityName)=0
 
virtual void printEntityControllers (const std::string &entityName)=0
 
virtual void resetPose ()=0
 

Detailed Description

Definition at line 45 of file EntityManagerInterface.h.

Constructor & Destructor Documentation

◆ ~EntityManagerInterface()

virtual mars::interfaces::EntityManagerInterface::~EntityManagerInterface ( )
inlinevirtual

Definition at line 48 of file EntityManagerInterface.h.

Member Function Documentation

◆ addController()

virtual void mars::interfaces::EntityManagerInterface::addController ( const std::string &  entityName,
unsigned long  controllerId 
)
pure virtual

adds a controller id to the controller list

Implemented in mars::sim::EntityManager.

◆ addEntity() [1/2]

virtual unsigned long mars::interfaces::EntityManagerInterface::addEntity ( const std::string &  name)
pure virtual

creates a new entity with the given name and returns its id

Implemented in mars::sim::EntityManager.

◆ addEntity() [2/2]

virtual unsigned long mars::interfaces::EntityManagerInterface::addEntity ( sim::SimEntity *  entity)
pure virtual

adds an existing entity to its entity map, returning the assigned id

Implemented in mars::sim::EntityManager.

◆ addJoint()

virtual void mars::interfaces::EntityManagerInterface::addJoint ( const std::string &  entityName,
unsigned long  jointId,
const std::string &  jointName 
)
pure virtual

adds a joint to the entity and maps the jointId to its name

Implemented in mars::sim::EntityManager.

◆ addMotor()

virtual void mars::interfaces::EntityManagerInterface::addMotor ( const std::string &  entityName,
unsigned long  motorId,
const std::string &  motorName 
)
pure virtual

adds a motor to the entity and maps the motorId to its name

Implemented in mars::sim::EntityManager.

◆ addNode()

virtual void mars::interfaces::EntityManagerInterface::addNode ( const std::string &  entityName,
unsigned long  nodeId,
const std::string &  nodeName 
)
pure virtual

adds a node to the entity and maps the nodeId to its name

Implemented in mars::sim::EntityManager.

◆ getEntity() [1/2]

virtual sim::SimEntity* mars::interfaces::EntityManagerInterface::getEntity ( const std::string &  name)
pure virtual

returns the entity with the given name

Implemented in mars::sim::EntityManager.

◆ getEntity() [2/2]

virtual sim::SimEntity* mars::interfaces::EntityManagerInterface::getEntity ( unsigned long  id)
pure virtual

returns the entity with the given id

Implemented in mars::sim::EntityManager.

◆ getEntityControllerList()

virtual std::vector<unsigned long> mars::interfaces::EntityManagerInterface::getEntityControllerList ( const std::string &  entityName)
pure virtual

Implemented in mars::sim::EntityManager.

◆ getEntityJoint()

virtual unsigned long mars::interfaces::EntityManagerInterface::getEntityJoint ( const std::string &  entityName,
const std::string &  jointName 
)
pure virtual

returns the node of the given entity; returns 0 if the entity or the node don't exist

Implemented in mars::sim::EntityManager.

◆ getEntityMotor()

virtual unsigned long mars::interfaces::EntityManagerInterface::getEntityMotor ( const std::string &  entityName,
const std::string &  motorName 
)
pure virtual

Implemented in mars::sim::EntityManager.

◆ getEntityNode()

virtual unsigned long mars::interfaces::EntityManagerInterface::getEntityNode ( const std::string &  entityName,
const std::string &  nodeName 
)
pure virtual

returns the node of the given entity; returns 0 if the entity or the node don't exist

Implemented in mars::sim::EntityManager.

◆ printEntityControllers()

virtual void mars::interfaces::EntityManagerInterface::printEntityControllers ( const std::string &  entityName)
pure virtual

Implemented in mars::sim::EntityManager.

◆ printEntityMotors()

virtual void mars::interfaces::EntityManagerInterface::printEntityMotors ( const std::string &  entityName)
pure virtual

Implemented in mars::sim::EntityManager.

◆ printEntityNodes()

virtual void mars::interfaces::EntityManagerInterface::printEntityNodes ( const std::string &  entityName)
pure virtual

Implemented in mars::sim::EntityManager.

◆ resetPose()

virtual void mars::interfaces::EntityManagerInterface::resetPose ( )
pure virtual

Implemented in mars::sim::EntityManager.

◆ selectEvent()

virtual void mars::interfaces::EntityManagerInterface::selectEvent ( unsigned long  id,
bool  mode 
)
pure virtual

Implemented in mars::sim::EntityManager.

◆ subscribeToEntityCreation()

virtual const std::map<unsigned long, sim::SimEntity*>* mars::interfaces::EntityManagerInterface::subscribeToEntityCreation ( EntitySubscriberInterface *  newsub)
pure virtual

Implemented in mars::sim::EntityManager.

The documentation for this class was generated from the following file: