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 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

Constructor & Destructor Documentation

Mailbox()

template<class Object >

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

(

const std::string &

name

)

References dynamicgraph::sot::Mailbox< Object >::objSOUT, dynamicgraph::sot::Mailbox< Object >::SOUT, and dynamicgraph::sot::Mailbox< Object >::timeSOUT.

~Mailbox()

template<class Object >

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

(

void

)

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

Member Function Documentation

get()

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 >::sotTimestampedObject::timestamp, and dynamicgraph::sot::Mailbox< Object >::update.

getClassName()

template<class Object >

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

inlinevirtual

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

getObject()

template<class Object >

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

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

getTimestamp()

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.

hasBeenUpdated()

template<class Object >

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

(

void

)

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

post()

template<class Object >

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

(

const Object &

obj

)

References 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.

Member Data Documentation

CLASS_NAME

template<class Object >

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

static

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

mainObject

template<class Object >

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

protected

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

mainObjectMutex

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().

mainTimeStamp

template<class Object >

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

protected

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

objSOUT

template<class Object >

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

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

SOUT

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().

timeSOUT

template<class Object >

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

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

update

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().