Public Member Functions | Static Public Attributes | List of all members
CustomEntity Struct Reference
Inheritance diagram for CustomEntity:
Inheritance graph
[legend]

Public Member Functions

 CustomEntity (const std::string &n)
 
void display (std::ostream &os) const
 Display information on the entity inside the output stream os. More...
 
virtual const std::string & getClassName () const
 
virtual ~CustomEntity ()
 
- Public Member Functions inherited from dynamicgraph::Entity
std::ostream & displaySignalList (std::ostream &os) const
 Display the list of signals of this entity in output stream os. More...
 
 Entity (const std::string &name)
 
const std::string & getCommandList () const
 
virtual std::string getDocString () const
 Returns the Entity documentation. More...
 
const std::string & getName () const
 
command::CommandgetNewStyleCommand (const std::string &cmdName)
 Provides the pointer towards the Command object cmdName. More...
 
CommandMap_t getNewStyleCommandMap ()
 Provides the std::map where all the commands are registered. More...
 
SignalBase< sigtime_t > & getSignal (const std::string &signalName)
 Provides a reference to the signal named signalName. More...
 
const SignalBase< sigtime_t > & getSignal (const std::string &signalName) const
 Provides a const reference to the signal named signalName. More...
 
SignalMap getSignalMap () const
 Provides a map of all the signals. More...
 
bool hasSignal (const std::string &signame) const
 Test if a signal of name signame is present. More...
 
virtual SignalBase< sigtime_t > * test ()
 
virtual void test2 (SignalBase< sigtime_t > *)
 
virtual std::ostream & writeCompletionList (std::ostream &os) const
 This method is used write in the output stream os the signals names and the commands of the entity. More...
 
virtual std::ostream & writeGraph (std::ostream &os) const
 This method is used to write down in os the edges of the graph by calling the signals writeGraph method. More...
 
virtual ~Entity ()
 
Loggerlogger ()
 
const Loggerlogger () const
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 Send messages msg with level t. Add string file and line to message. More...
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 Specify the verbosity level of the logger. More...
 
LoggerVerbosity getLoggerVerbosityLevel ()
 Get the logger's verbosity level. More...
 
bool setTimeSample (double t)
 Set the time sample. More...
 
double getTimeSample ()
 Get the time sample. More...
 
bool setStreamPrintPeriod (double t)
 Set the period of the stream period. More...
 
double getStreamPrintPeriod ()
 Get the period of the stream period. More...
 

Static Public Attributes

static const std::string CLASS_NAME
 

Additional Inherited Members

- Public Types inherited from dynamicgraph::Entity
typedef std::map< const std::string, command::Command * > CommandMap_t
 
typedef std::map< std::string, SignalBase< sigtime_t > * > SignalMap
 
- Protected Member Functions inherited from dynamicgraph::Entity
void addCommand (const std::string &name, command::Command *command)
 Add a command to Entity. More...
 
void entityDeregistration ()
 
void entityRegistration ()
 
void signalDeregistration (const std::string &name)
 
void signalRegistration (const SignalArray< sigtime_t > &signals)
 
- Protected Attributes inherited from dynamicgraph::Entity
CommandMap_t commandMap
 
Logger logger_
 
std::string name
 
SignalMap signalMap
 

Detailed Description

Definition at line 22 of file custom-entity.cpp.

Constructor & Destructor Documentation

◆ CustomEntity()

CustomEntity::CustomEntity ( const std::string &  n)
inlineexplicit

Definition at line 27 of file custom-entity.cpp.

◆ ~CustomEntity()

virtual CustomEntity::~CustomEntity ( )
inlinevirtual

Definition at line 29 of file custom-entity.cpp.

Member Function Documentation

◆ display()

void CustomEntity::display ( std::ostream &  os) const
inlinevirtual

Display information on the entity inside the output stream os.

Reimplemented from dynamicgraph::Entity.

Definition at line 31 of file custom-entity.cpp.

◆ getClassName()

virtual const std::string& CustomEntity::getClassName ( ) const
inlinevirtual

Reimplemented from dynamicgraph::Entity.

Definition at line 25 of file custom-entity.cpp.

Member Data Documentation

◆ CLASS_NAME

const std::string CustomEntity::CLASS_NAME
static

Definition at line 23 of file custom-entity.cpp.


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


dynamic-graph
Author(s): Nicolas Mansard, Olivier Stasse
autogenerated on Sun Oct 22 2023 02:27:08