dynamicgraph::Signal< T, Time > Class Template Reference

Signals link I/O ports of entities. They can be constant-valued signals, or copy the value of a heap variable, or evaluated as a function. See SignalPtr and SignalTimeDependent for other types of signals, and SignalArray for a way of grouping them. More...

#include <dynamic-graph/signal.h>

Inheritance diagram for dynamicgraph::Signal< T, Time >:

Collaboration diagram for dynamicgraph::Signal< T, Time >:

Public Types
typedef int *	Mutex
typedef int *	MutexError

Public Member Functions
	Signal (std::string name)
virtual	~Signal ()
virtual void	get (std::ostream &value) const
virtual void	set (std::istringstream &value)
virtual void	trace (std::ostream &os) const
virtual void	setConstant (const T &t)
virtual void	setReference (const T *t, Mutex *mutexref=NULL)
virtual void	setReferenceNonConstant (T *t, Mutex *mutexref=NULL)
virtual void	setFunction (boost::function2< T &, T &, Time > t, Mutex *mutexref=NULL)
bool	getKeepReference ()
void	setKeepReference (const bool &b)
virtual const T &	access (const Time &t)
virtual void	recompute (const Time &t)
virtual const T &	accessCopy () const
virtual std::ostream &	display (std::ostream &os) const
virtual const T &	operator() (const Time &t)
virtual Signal< T, Time > &	operator= (const T &t)
	operator const T & () const
virtual void	getClassName (std::string &aClassName) const
virtual void	checkCompatibility ()
Public Member Functions inherited from dynamicgraph::SignalBase< Time >
	SignalBase (std::string name="")
virtual	~SignalBase ()
virtual const Time &	getTime () const
virtual void	setTime (const Time &t)
const bool &	getReady () const
const std::string &	getName () const
void	getClassName (std::string &aClassName) const
virtual void	setPeriodTime (const Time &)
virtual Time	getPeriodTime () const
virtual void	addDependency (const SignalBase< Time > &)
virtual void	removeDependency (const SignalBase< Time > &)
virtual void	clearDependencies ()
virtual bool	needUpdate (const Time &) const
void	setReady (const bool sready=true)
virtual std::ostream &	writeGraph (std::ostream &os) const
virtual std::ostream &	displayDependencies (std::ostream &os, const int=-1, std::string space="", std::string next1="", std::string="") const
virtual void	plug (SignalBase< Time > *sigarg)
virtual void	unplug ()
virtual bool	isPlugged () const
virtual SignalBase< Time > *	getPluged () const
virtual void	setConstantDefault ()
std::string	shortName () const
virtual void	ExtractNodeAndLocalNames (std::string &LocalName, std::string &NodeName) const

Protected Types
enum	SignalType {   CONSTANT ,   REFERENCE ,   REFERENCE_NON_CONST ,   FUNCTION }

Protected Attributes
SignalType	signalType
T	Tcopy1
T	Tcopy2
T *	Tcopy
bool	copyInit
const T *	Treference
T *	TreferenceNonConst
boost::function2< T &, T &, Time >	Tfunction
bool	keepReference
Mutex *	providerMutex
Protected Attributes inherited from dynamicgraph::SignalBase< Time >
std::string	name
Time	signalTime
bool	ready

Static Protected Attributes
static const SignalType	SIGNAL_TYPE_DEFAULT = CONSTANT
static const bool	KEEP_REFERENCE_DEFAULT = false

Detailed Description

template<class T, class Time>
class dynamicgraph::Signal< T, Time >

Signals link I/O ports of entities. They can be constant-valued signals, or copy the value of a heap variable, or evaluated as a function. See SignalPtr and SignalTimeDependent for other types of signals, and SignalArray for a way of grouping them.

There are several ways to specify the value output by a signal:

• using the function setConstant(T) to set the value of the signal to T;
• using the function setReference(mutex, T*) to set the value from a pointer, whose access is restricted by a mutex;
• using the function setFunction(boost::function2) that will be called when the signal's value is accessed.

Member Typedef Documentation

Mutex

template<class T, class Time>

typedef int* dynamicgraph::Signal< T, Time >::Mutex

MutexError

template<class T, class Time>

typedef int* dynamicgraph::Signal< T, Time >::MutexError

Member Enumeration Documentation

SignalType

template<class T, class Time>

enum dynamicgraph::Signal::SignalType

protected

Enumerator
CONSTANT
REFERENCE
REFERENCE_NON_CONST
FUNCTION

Constructor & Destructor Documentation

Signal()

template<class T, class Time>

dynamicgraph::Signal< T, Time >::Signal

(

std::string

name

)

References __SIGNAL_INIT, and dynamicgraph::SignalBase< Time >::name.

Referenced by dynamicgraph::SignalPtr< T, Time >::getPtr(), dynamicgraph::SignalPtr< T, Time >::getPtr(), dynamicgraph::SignalPtr< T, Time >::operator*(), dynamicgraph::SignalPtr< T, Time >::operator*(), dynamicgraph::SignalPtr< T, Time >::operator->(), dynamicgraph::SignalPtr< T, Time >::operator->(), operator=(), dynamicgraph::SignalPtr< T, Time >::operator=(), dynamicgraph::SignalPtr< T, Time >::plug(), dynamicgraph::SignalPtr< T, Time >::SignalPtr(), dynamicgraph::SignalTimeDependent< T, Time >::SignalTimeDependent(), dynamicgraph::SignalTimeDependent< T, Time >::SignalTimeDependent(), and dynamicgraph::SignalTimeDependent< T, Time >::SignalTimeDependent().

~Signal()

template<class T, class Time>

virtual dynamicgraph::Signal< T, Time >::~Signal ( )

inlinevirtual

Member Function Documentation

access()

template<class T, class Time>

const T & dynamicgraph::Signal< T, Time >::access ( const Time & t )

virtual

Reimplemented in dynamicgraph::SignalPtr< T, Time >, dynamicgraph::SignalTimeDependent< T, Time >, and dynamicgraph::SignalTimeDependent< int, int >.

References accessCopy(), CONSTANT, copyInit, FUNCTION, dynamicgraph::SignalBase< Time >::getReady(), providerMutex, REFERENCE, REFERENCE_NON_CONST, dynamicgraph::SignalBase< Time >::setReady(), dynamicgraph::SignalBase< Time >::setTime(), dynamicgraph::SignalBase< Time >::signalTime, signalType, Tfunction, and Treference.

Referenced by dynamicgraph::SignalPtr< T, Time >::access(), dynamicgraph::SignalTimeDependent< T, Time >::access(), operator()(), and recompute().

accessCopy()

template<class T, class Time>

const T & dynamicgraph::Signal< T, Time >::accessCopy ( ) const

virtual

Reimplemented in dynamicgraph::SignalPtr< T, Time >.

References Tcopy.

Referenced by access(), dynamicgraph::SignalPtr< T, Time >::access(), dynamicgraph::SignalTimeDependent< T, Time >::access(), dynamicgraph::SignalPtr< T, Time >::accessCopy(), get(), dynamicgraph::Signal< int, int >::operator const int &(), and trace().

checkCompatibility()

template<class T, class Time>

virtual void dynamicgraph::Signal< T, Time >::checkCompatibility ( )

inlinevirtual

Reimplemented from dynamicgraph::SignalBase< Time >.

Reimplemented in dynamicgraph::SignalPtr< T, Time >.

References Tcopy.

Referenced by dynamicgraph::SignalPtr< T, Time >::checkCompatibility().

display()

template<class T, class Time>

std::ostream & dynamicgraph::Signal< T, Time >::display ( std::ostream & os ) const

virtual

Reimplemented from dynamicgraph::SignalBase< Time >.

Reimplemented in dynamicgraph::SignalPtr< T, Time >.

References CONSTANT, FUNCTION, dynamicgraph::SignalBase< Time >::name, REFERENCE, REFERENCE_NON_CONST, and signalType.

Referenced by dynamicgraph::SignalPtr< T, Time >::display().

get()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::get ( std::ostream & value ) const

virtual

Reimplemented from dynamicgraph::SignalBase< Time >.

References accessCopy(), and dynamicgraph::signal_disp().

getClassName()

template<class T, class Time>

virtual void dynamicgraph::Signal< T, Time >::getClassName ( std::string & aClassName ) const

inlinevirtual

References dynamicgraph::SignalBase< Time >::name.

getKeepReference()

template<class T, class Time>

bool dynamicgraph::Signal< T, Time >::getKeepReference ( )

inline

References keepReference.

operator const T &()

template<class T, class Time>

dynamicgraph::Signal< T, Time >::operator const T & ( ) const

inline

operator()()

template<class T, class Time>

virtual const T & dynamicgraph::Signal< T, Time >::operator() ( const Time & t )

inlinevirtual

Reimplemented in dynamicgraph::SignalPtr< T, Time >, dynamicgraph::SignalTimeDependent< T, Time >, and dynamicgraph::SignalTimeDependent< int, int >.

References access().

operator=()

template<class T, class Time>

Signal< T, Time > & dynamicgraph::Signal< T, Time >::operator= ( const T & t )

virtual

Reimplemented in dynamicgraph::SignalPtr< T, Time >.

References keepReference, providerMutex, REFERENCE_NON_CONST, setConstant(), Signal(), signalType, and TreferenceNonConst.

recompute()

template<class T, class Time>

virtual void dynamicgraph::Signal< T, Time >::recompute ( const Time & t )

inlinevirtual

Reimplemented from dynamicgraph::SignalBase< Time >.

References access().

set()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::set ( std::istringstream & value )

virtual

Reimplemented from dynamicgraph::SignalBase< Time >.

References dynamicgraph::signal_cast().

setConstant()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::setConstant ( const T & t )

virtual

Reimplemented in dynamicgraph::SignalPtr< T, Time >.

References CONSTANT, dynamicgraph::SignalBase< Time >::setReady(), and signalType.

Referenced by operator=(), dynamicgraph::SignalPtr< T, Time >::setConstant(), and dynamicgraph::SignalPtr< T, Time >::setConstantDefault().

setFunction()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::setFunction ( boost::function2< T &, T &, Time > t, Mutex * mutexref = NULL )

virtual

References copyInit, FUNCTION, providerMutex, dynamicgraph::SignalBase< Time >::setReady(), signalType, and Tfunction.

Referenced by dynamicgraph::SignalPtr< T, Time >::setFunction(), and dynamicgraph::SignalTimeDependent< T, Time >::SignalTimeDependent().

setKeepReference()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::setKeepReference ( const bool & b )

inline

References keepReference.

setReference()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::setReference ( const T * t, Mutex * mutexref = NULL )

virtual

References copyInit, providerMutex, REFERENCE, dynamicgraph::SignalBase< Time >::setReady(), signalType, and Treference.

Referenced by dynamicgraph::SignalPtr< T, Time >::plug(), and dynamicgraph::SignalPtr< T, Time >::setReference().

setReferenceNonConstant()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::setReferenceNonConstant ( T * t, Mutex * mutexref = NULL )

virtual

References copyInit, providerMutex, REFERENCE_NON_CONST, dynamicgraph::SignalBase< Time >::setReady(), signalType, Treference, and TreferenceNonConst.

trace()

template<class T, class Time>

void dynamicgraph::Signal< T, Time >::trace ( std::ostream & os ) const

virtual

Reimplemented from dynamicgraph::SignalBase< Time >.

References accessCopy(), DG_RETHROW, DG_THROW, dynamicgraph::SignalBase< Time >::getName(), dynamicgraph::ExceptionSignal::SET_IMPOSSIBLE, and dynamicgraph::signal_trace().

Member Data Documentation

copyInit

template<class T, class Time>

bool dynamicgraph::Signal< T, Time >::copyInit

protected

Referenced by access(), dynamicgraph::SignalPtr< T, Time >::access(), dynamicgraph::SignalPtr< T, Time >::accessCopy(), setFunction(), setReference(), and setReferenceNonConstant().

KEEP_REFERENCE_DEFAULT

template<class T, class Time>

const bool dynamicgraph::Signal< T, Time >::KEEP_REFERENCE_DEFAULT = false

staticprotected

keepReference

template<class T, class Time>

bool dynamicgraph::Signal< T, Time >::keepReference

protected

Referenced by getKeepReference(), operator=(), and setKeepReference().

providerMutex

template<class T, class Time>

Mutex* dynamicgraph::Signal< T, Time >::providerMutex

protected

Referenced by access(), operator=(), setFunction(), setReference(), and setReferenceNonConstant().

SIGNAL_TYPE_DEFAULT

template<class T, class Time>

const SignalType dynamicgraph::Signal< T, Time >::SIGNAL_TYPE_DEFAULT = CONSTANT

staticprotected

signalType

template<class T, class Time>

SignalType dynamicgraph::Signal< T, Time >::signalType

protected

Referenced by access(), display(), operator=(), setConstant(), setFunction(), setReference(), and setReferenceNonConstant().

Tcopy

template<class T, class Time>

T* dynamicgraph::Signal< T, Time >::Tcopy

protected

Referenced by accessCopy(), and checkCompatibility().

Tcopy1

template<class T, class Time>

T dynamicgraph::Signal< T, Time >::Tcopy1

protected

Referenced by dynamicgraph::SignalPtr< T, Time >::plug().

Tcopy2

template<class T, class Time>

T dynamicgraph::Signal< T, Time >::Tcopy2

protected

Tfunction

template<class T, class Time>

boost::function2<T&,T&,Time> dynamicgraph::Signal< T, Time >::Tfunction

protected

Referenced by access(), and setFunction().

Treference

template<class T, class Time>

const T* dynamicgraph::Signal< T, Time >::Treference

protected

Referenced by access(), setReference(), and setReferenceNonConstant().

TreferenceNonConst

template<class T, class Time>

T* dynamicgraph::Signal< T, Time >::TreferenceNonConst

protected

Referenced by operator=(), and setReferenceNonConstant().