dynamicgraph::sot::Mailbox< Object > Class Template Reference

#include <sot/core/mailbox.hh>

Inheritance diagram for dynamicgraph::sot::Mailbox< Object >:

Classes
struct	sotTimestampedObject

Public Member Functions
virtual const std::string &	getClassName (void) const
	Mailbox (const std::string &name)
	~Mailbox (void)
void	post (const Object &obj)
sotTimestampedObject &	get (sotTimestampedObject &res, const int &dummy)
Object &	getObject (Object &res, const int &time)
struct timeval &	getTimestamp (struct timeval &res, const int &time)
bool	hasBeenUpdated (void)
Public Member Functions inherited from dynamicgraph::Entity
	Entity (const std::string &name)
virtual	~Entity ()
const std::string &	getName () const
virtual std::string	getDocString () const
bool	hasSignal (const std::string &signame) const
SignalBase< int > &	getSignal (const std::string &signalName)
const SignalBase< int > &	getSignal (const std::string &signalName) const
std::ostream &	displaySignalList (std::ostream &os) const
virtual std::ostream &	writeGraph (std::ostream &os) const
virtual std::ostream &	writeCompletionList (std::ostream &os) const
virtual void	display (std::ostream &os) const
virtual SignalBase< int > *	test ()
virtual void	test2 (SignalBase< int > *)
const std::string &	getCommandList () const
CommandMap_t	getNewStyleCommandMap ()
command::Command *	getNewStyleCommand (const std::string &cmdName)
SignalMap	getSignalMap () const
void	sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const char *file="", int line=0)
void	setLoggerVerbosityLevel (LoggerVerbosity lv)
LoggerVerbosity	getLoggerVerbosityLevel ()

Public Attributes
dg::SignalTimeDependent< struct sotTimestampedObject, int >	SOUT
dg::SignalTimeDependent< Object, int >	objSOUT
dg::SignalTimeDependent< struct timeval, int >	timeSOUT

Static Public Attributes
static const std::string	CLASS_NAME

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

Additional Inherited Members
Public Types inherited from dynamicgraph::Entity
typedef std::map< std::string, SignalBase< int > * >	SignalMap
typedef std::map< const std::string, command::Command * >	CommandMap_t
Protected Member Functions inherited from dynamicgraph::Entity
void	addCommand (const std::string &name, command::Command *command)
void	entityRegistration ()
void	entityDeregistration ()
void	signalRegistration (const SignalArray< int > &signals)
void	signalDeregistration (const std::string &name)

Constructor & Destructor Documentation

template<class Object >

dynamicgraph::sot::Mailbox< Object >::Mailbox

(

const std::string &

name

)

References dynamicgraph::sot::Mailbox< Object >::objSOUT, dynamicgraph::Entity::signalRegistration(), dynamicgraph::sot::Mailbox< Object >::SOUT, dynamicgraph::sot::Mailbox< Object >::timeSOUT, and dynamicgraph::sot::Mailbox< Object >::~Mailbox().

template<class Object >

dynamicgraph::sot::Mailbox< Object >::~Mailbox

(

void

)

References dynamicgraph::sot::Mailbox< Object >::hasBeenUpdated(), and dynamicgraph::sot::Mailbox< Object >::mainObjectMutex.

Referenced by dynamicgraph::sot::Mailbox< Object >::Mailbox().

Member Function Documentation

template<class Object >

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

References dynamicgraph::sot::Mailbox< Object >::mainObject, dynamicgraph::sot::Mailbox< Object >::mainObjectMutex, dynamicgraph::sot::Mailbox< Object >::mainTimeStamp, dynamicgraph::sot::Mailbox< Object >::sotTimestampedObject::obj, dynamicgraph::sot::Mailbox< Object >::post(), dynamicgraph::sot::Mailbox< Object >::sotTimestampedObject::timestamp, and dynamicgraph::sot::Mailbox< Object >::update.

Referenced by dynamicgraph::sot::Mailbox< Object >::hasBeenUpdated().

template<class Object >

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

inlinevirtual

Reimplemented from dynamicgraph::Entity.

References dynamicgraph::sot::Mailbox< Object >::CLASS_NAME.

template<class Object >

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

References dynamicgraph::sot::Mailbox< Object >::getTimestamp(), dynamicgraph::sot::Mailbox< Object >::sotTimestampedObject::obj, and dynamicgraph::sot::Mailbox< Object >::SOUT.

Referenced by dynamicgraph::sot::Mailbox< Object >::post().

template<class Object >

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

References dynamicgraph::sot::Mailbox< Object >::SOUT, and dynamicgraph::sot::Mailbox< Object >::sotTimestampedObject::timestamp.

Referenced by dynamicgraph::sot::Mailbox< Object >::getObject().

template<class Object >

bool dynamicgraph::sot::Mailbox< Object >::hasBeenUpdated

(

void

)

References dynamicgraph::sot::Mailbox< Object >::get(), dynamicgraph::sot::Mailbox< Object >::mainObjectMutex, and dynamicgraph::sot::Mailbox< Object >::update.

Referenced by dynamicgraph::sot::Mailbox< Object >::~Mailbox().

template<class Object >

void dynamicgraph::sot::Mailbox< Object >::post

(

const Object &

obj

)

References dynamicgraph::sot::Mailbox< Object >::getObject(), dynamicgraph::sot::Mailbox< Object >::mainObject, dynamicgraph::sot::Mailbox< Object >::mainObjectMutex, dynamicgraph::sot::Mailbox< Object >::mainTimeStamp, dynamicgraph::sot::Mailbox< Object >::SOUT, and dynamicgraph::sot::Mailbox< Object >::update.

Referenced by dynamicgraph::sot::Mailbox< Object >::get().

Member Data Documentation

template<class Object >

const std::string dynamicgraph::sot::Mailbox< Object >::CLASS_NAME

static

Referenced by dynamicgraph::sot::Mailbox< Object >::getClassName().

template<class Object >

Object dynamicgraph::sot::Mailbox< Object >::mainObject

protected

Referenced by dynamicgraph::sot::Mailbox< Object >::get(), and dynamicgraph::sot::Mailbox< Object >::post().

template<class Object >

boost::timed_mutex dynamicgraph::sot::Mailbox< Object >::mainObjectMutex

protected

Referenced by dynamicgraph::sot::Mailbox< Object >::get(), dynamicgraph::sot::Mailbox< Object >::hasBeenUpdated(), dynamicgraph::sot::Mailbox< Object >::post(), and dynamicgraph::sot::Mailbox< Object >::~Mailbox().

template<class Object >

struct timeval dynamicgraph::sot::Mailbox< Object >::mainTimeStamp

protected

Referenced by dynamicgraph::sot::Mailbox< Object >::get(), and dynamicgraph::sot::Mailbox< Object >::post().

template<class Object >

dg::SignalTimeDependent< Object,int > dynamicgraph::sot::Mailbox< Object >::objSOUT

Referenced by dynamicgraph::sot::Mailbox< Object >::Mailbox().

template<class Object >

dg::SignalTimeDependent< struct sotTimestampedObject,int > dynamicgraph::sot::Mailbox< Object >::SOUT

Referenced by dynamicgraph::sot::Mailbox< Object >::getObject(), dynamicgraph::sot::Mailbox< Object >::getTimestamp(), dynamicgraph::sot::Mailbox< Object >::Mailbox(), and dynamicgraph::sot::Mailbox< Object >::post().

template<class Object >

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

Referenced by dynamicgraph::sot::Mailbox< Object >::Mailbox().

template<class Object >

bool dynamicgraph::sot::Mailbox< Object >::update

protected

Referenced by dynamicgraph::sot::Mailbox< Object >::get(), dynamicgraph::sot::Mailbox< Object >::hasBeenUpdated(), and dynamicgraph::sot::Mailbox< Object >::post().