Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | List of all members
dynamicgraph::sot::Mailbox< Object > Class Template Reference

#include <mailbox.hh>

Inheritance diagram for dynamicgraph::sot::Mailbox< Object >:
Inheritance graph
[legend]

Public Types

typedef MailboxTimestampedObject< Object > sotTimestampedObject
 
- Public Types inherited from dynamicgraph::Entity
typedef std::map< const std::string, command::Command *> CommandMap_t
 
typedef std::map< std::string, SignalBase< int > *> SignalMap
 

Public Member Functions

sotTimestampedObjectget (sotTimestampedObject &res, const int &dummy)
 
virtual const std::string & getClassName (void) const
 
Object & getObject (Object &res, const int &time)
 
struct timeval & getTimestamp (struct timeval &res, const int &time)
 
bool hasBeenUpdated (void)
 
 Mailbox (const std::string &name)
 
void post (const Object &obj)
 
 ~Mailbox (void)
 
- Public Member Functions inherited from dynamicgraph::Entity
virtual void display (std::ostream &os) const
 
std::ostream & displaySignalList (std::ostream &os) const
 
 Entity (const std::string &name)
 
const std::string & getCommandList () const
 
virtual std::string getDocString () const
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
const std::string & getName () const
 
command::CommandgetNewStyleCommand (const std::string &cmdName)
 
CommandMap_t getNewStyleCommandMap ()
 
SignalBase< int > & getSignal (const std::string &signalName)
 
const SignalBase< int > & getSignal (const std::string &signalName) const
 
SignalMap getSignalMap () const
 
double getStreamPrintPeriod ()
 
double getStreamPrintPeriod ()
 
double getTimeSample ()
 
double getTimeSample ()
 
bool hasSignal (const std::string &signame) const
 
Loggerlogger ()
 
Logger const & logger () const
 
Loggerlogger ()
 
Logger const & logger () const
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
bool setStreamPrintPeriod (double t)
 
bool setStreamPrintPeriod (double t)
 
bool setTimeSample (double t)
 
bool setTimeSample (double t)
 
virtual SignalBase< int > * test ()
 
virtual void test2 (SignalBase< int > *)
 
virtual std::ostream & writeCompletionList (std::ostream &os) const
 
virtual std::ostream & writeGraph (std::ostream &os) const
 
virtual ~Entity ()
 

Public Attributes

dynamicgraph::SignalTimeDependent< Object, int > objSOUT
 
dynamicgraph::SignalTimeDependent< sotTimestampedObject, int > SOUT
 
dynamicgraph::SignalTimeDependent< struct timeval, int > timeSOUT
 

Static Public Attributes

static const std::string CLASS_NAME
 

Protected Attributes

Object mainObject
 
boost::timed_mutex mainObjectMutex
 
struct timeval mainTimeStamp
 
bool update
 
- Protected Attributes inherited from dynamicgraph::Entity
CommandMap_t commandMap
 
Logger logger_
 
std::string name
 
SignalMap signalMap
 

Additional Inherited Members

- Protected Member Functions inherited from dynamicgraph::Entity
void addCommand (const std::string &name, command::Command *command)
 
void entityDeregistration ()
 
void entityRegistration ()
 
void signalDeregistration (const std::string &name)
 
void signalRegistration (const SignalArray< int > &signals)
 

Detailed Description

template<class Object>
class dynamicgraph::sot::Mailbox< Object >

Definition at line 43 of file mailbox.hh.

Member Typedef Documentation

◆ sotTimestampedObject

template<class Object >
typedef MailboxTimestampedObject<Object> dynamicgraph::sot::Mailbox< Object >::sotTimestampedObject

Definition at line 49 of file mailbox.hh.

Constructor & Destructor Documentation

◆ Mailbox()

template<class Object >
dynamicgraph::sot::Mailbox< Object >::Mailbox ( const std::string &  name)

◆ ~Mailbox()

template<class Object >
dynamicgraph::sot::Mailbox< Object >::~Mailbox ( void  )

Member Function Documentation

◆ get()

template<class Object >
sotTimestampedObject& dynamicgraph::sot::Mailbox< Object >::get ( sotTimestampedObject res,
const int &  dummy 
)

◆ getClassName()

template<class Object >
virtual const std::string& dynamicgraph::sot::Mailbox< Object >::getClassName ( void  ) const
inlinevirtual

Reimplemented from dynamicgraph::Entity.

Definition at line 46 of file mailbox.hh.

◆ getObject()

template<class Object >
Object& dynamicgraph::sot::Mailbox< Object >::getObject ( Object &  res,
const int &  time 
)

◆ getTimestamp()

template<class Object >
struct timeval& dynamicgraph::sot::Mailbox< Object >::getTimestamp ( struct timeval &  res,
const int &  time 
)

◆ hasBeenUpdated()

template<class Object >
bool dynamicgraph::sot::Mailbox< Object >::hasBeenUpdated ( void  )

◆ post()

template<class Object >
void dynamicgraph::sot::Mailbox< Object >::post ( const Object &  obj)

Member Data Documentation

◆ CLASS_NAME

template<class Object >
const std::string dynamicgraph::sot::Mailbox< Object >::CLASS_NAME
static

Definition at line 45 of file mailbox.hh.

◆ mainObject

template<class Object >
Object dynamicgraph::sot::Mailbox< Object >::mainObject
protected

Definition at line 65 of file mailbox.hh.

◆ mainObjectMutex

template<class Object >
boost::timed_mutex dynamicgraph::sot::Mailbox< Object >::mainObjectMutex
protected

Definition at line 64 of file mailbox.hh.

◆ mainTimeStamp

template<class Object >
struct timeval dynamicgraph::sot::Mailbox< Object >::mainTimeStamp
protected

Definition at line 66 of file mailbox.hh.

◆ objSOUT

template<class Object >
dynamicgraph::SignalTimeDependent<Object, int> dynamicgraph::sot::Mailbox< Object >::objSOUT

Definition at line 71 of file mailbox.hh.

◆ SOUT

Definition at line 70 of file mailbox.hh.

◆ timeSOUT

template<class Object >
dynamicgraph::SignalTimeDependent<struct timeval, int> dynamicgraph::sot::Mailbox< Object >::timeSOUT

Definition at line 72 of file mailbox.hh.

◆ update

template<class Object >
bool dynamicgraph::sot::Mailbox< Object >::update
protected

Definition at line 67 of file mailbox.hh.


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


sot-core
Author(s): Olivier Stasse, ostasse@laas.fr
autogenerated on Wed Jun 21 2023 02:51:27