The base class for signals: not to be used as such. More...

#include <fwd.hh>

Inheritance diagram for dynamicgraph::SignalBase< Time >:

Public Member Functions
	SignalBase (std::string name="")

virtual	~SignalBase ()

Time
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

Dependencies
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

Plug
virtual void	plug (SignalBase< Time > *sigarg)

virtual void	unplug ()

virtual bool	isPlugged () const

virtual SignalBase< Time > *	getPluged () const

virtual void	setConstantDefault ()

Set
virtual void	set (std::istringstream &)

virtual void	get (std::ostream &) const

virtual void	recompute (const Time &)

virtual void	trace (std::ostream &) const

Display
virtual std::ostream &	display (std::ostream &os) const

std::string	shortName () const

Information providers
virtual void	ExtractNodeAndLocalNames (std::string &LocalName, std::string &NodeName) const

Test
virtual void	checkCompatibility ()

Protected Attributes
std::string	name

bool	ready

Time	signalTime

Detailed Description

template<class Time>
class dynamicgraph::SignalBase< Time >

The base class for signals: not to be used as such.

Signal values can be accessed programmatically using the access () or accessCopy () methods; the former directly accesses the value of the signal, which can involve an extra computation, while the latter accesses a cached value, or 'copy'.

Definition at line 51 of file fwd.hh.

Constructor & Destructor Documentation

◆ SignalBase()

template<class Time>

dynamicgraph::SignalBase< Time >::SignalBase ( std::string name = "" )

inlineexplicit

Definition at line 29 of file signal-base.h.

◆ ~SignalBase()

template<class Time>

virtual dynamicgraph::SignalBase< Time >::~SignalBase ( )

inlinevirtual

Definition at line 32 of file signal-base.h.

Member Function Documentation

◆ addDependency()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::addDependency ( const SignalBase< Time > & )

inlinevirtual

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

Definition at line 57 of file signal-base.h.

◆ checkCompatibility()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::checkCompatibility ( )

inlinevirtual

Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, dynamicgraph::Signal< Vector, int >, dynamicgraph::Signal< double, int >, dynamicgraph::SignalPtr< T, Time >, and dynamicgraph::SignalPtr< double, int >.

Definition at line 191 of file signal-base.h.

◆ clearDependencies()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::clearDependencies ( )

inlinevirtual

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

Definition at line 61 of file signal-base.h.

◆ display()

template<class Time>

virtual std::ostream& dynamicgraph::SignalBase< Time >::display ( std::ostream & os ) const

inlinevirtual

Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, dynamicgraph::Signal< Vector, int >, dynamicgraph::Signal< double, int >, dynamicgraph::SignalPtr< T, Time >, and dynamicgraph::SignalPtr< double, int >.

Definition at line 154 of file signal-base.h.

◆ displayDependencies()

template<class Time>

virtual std::ostream& dynamicgraph::SignalBase< Time >::displayDependencies	(	std::ostream &	os,
		const int	= `-1`,
		std::string	space = `""`,
		std::string	next1 = `""`,
		std::string	= `""`
	)		const

inlinevirtual

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

Definition at line 69 of file signal-base.h.

◆ ExtractNodeAndLocalNames()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::ExtractNodeAndLocalNames	(	std::string &	LocalName,
		std::string &	NodeName
	)		const

inlinevirtual

Definition at line 174 of file signal-base.h.

◆ get()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::get ( std::ostream & ) const

inlinevirtual

Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, dynamicgraph::Signal< Vector, int >, and dynamicgraph::Signal< double, int >.

Definition at line 128 of file signal-base.h.

◆ getClassName()

template<class Time>

void dynamicgraph::SignalBase< Time >::getClassName ( std::string & aClassName ) const

inline

Definition at line 44 of file signal-base.h.

◆ getName()

template<class Time>

const std::string& dynamicgraph::SignalBase< Time >::getName ( ) const

inline

Definition at line 42 of file signal-base.h.

◆ getPeriodTime()

template<class Time>

virtual Time dynamicgraph::SignalBase< Time >::getPeriodTime ( ) const

inlinevirtual

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

Definition at line 50 of file signal-base.h.

◆ getPluged()

template<class Time>

virtual SignalBase<Time>* dynamicgraph::SignalBase< Time >::getPluged ( ) const

inlinevirtual

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

Definition at line 104 of file signal-base.h.

◆ getReady()

template<class Time>

const bool& dynamicgraph::SignalBase< Time >::getReady ( ) const

inline

Definition at line 40 of file signal-base.h.

◆ getTime()

template<class Time>

virtual const Time& dynamicgraph::SignalBase< Time >::getTime ( ) const

inlinevirtual

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

Definition at line 36 of file signal-base.h.

◆ isPlugged()

template<class Time>

virtual bool dynamicgraph::SignalBase< Time >::isPlugged ( ) const

inlinevirtual

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

Definition at line 102 of file signal-base.h.

◆ needUpdate()

template<class Time>

virtual bool dynamicgraph::SignalBase< Time >::needUpdate ( const Time & ) const

inlinevirtual

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

Definition at line 63 of file signal-base.h.

◆ plug()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::plug ( SignalBase< Time > * sigarg )

inlinevirtual

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

Definition at line 87 of file signal-base.h.

◆ recompute()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::recompute ( const Time & )

inlinevirtual

Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, dynamicgraph::Signal< Vector, int >, and dynamicgraph::Signal< double, int >.

Definition at line 135 of file signal-base.h.

◆ removeDependency()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::removeDependency ( const SignalBase< Time > & )

inlinevirtual

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

Definition at line 59 of file signal-base.h.

◆ set()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::set ( std::istringstream & )

inlinevirtual

Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, dynamicgraph::Signal< Vector, int >, and dynamicgraph::Signal< double, int >.

Definition at line 121 of file signal-base.h.

◆ setConstantDefault()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::setConstantDefault ( )

inlinevirtual

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

Definition at line 106 of file signal-base.h.

◆ setPeriodTime()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::setPeriodTime ( const Time & )

inlinevirtual

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

Definition at line 48 of file signal-base.h.

◆ setReady()

template<class Time>

void dynamicgraph::SignalBase< Time >::setReady ( const bool sready = true )

inline

Definition at line 65 of file signal-base.h.

◆ setTime()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::setTime ( const Time & t )

inlinevirtual

Definition at line 38 of file signal-base.h.

◆ shortName()

template<class Time>

std::string dynamicgraph::SignalBase< Time >::shortName ( ) const

inline

Definition at line 159 of file signal-base.h.

◆ trace()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::trace ( std::ostream & ) const

inlinevirtual

Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, dynamicgraph::Signal< Vector, int >, and dynamicgraph::Signal< double, int >.

Definition at line 142 of file signal-base.h.

◆ unplug()

template<class Time>

virtual void dynamicgraph::SignalBase< Time >::unplug ( )

inlinevirtual

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

Definition at line 95 of file signal-base.h.

◆ writeGraph()

template<class Time>

virtual std::ostream& dynamicgraph::SignalBase< Time >::writeGraph ( std::ostream & os ) const

inlinevirtual

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

Definition at line 67 of file signal-base.h.

Member Data Documentation

◆ name

template<class Time>

std::string dynamicgraph::SignalBase< Time >::name

protected

Definition at line 200 of file signal-base.h.

◆ ready

template<class Time>

bool dynamicgraph::SignalBase< Time >::ready

protected

Definition at line 202 of file signal-base.h.

◆ signalTime

template<class Time>

Time dynamicgraph::SignalBase< Time >::signalTime

protected

Definition at line 201 of file signal-base.h.

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

Public Member Functions

Protected Attributes

Detailed Description

template<class Time> class dynamicgraph::SignalBase< Time >

Constructor & Destructor Documentation

◆ SignalBase()

◆ ~SignalBase()

Member Function Documentation

◆ addDependency()

◆ checkCompatibility()

◆ clearDependencies()

◆ display()

◆ displayDependencies()

◆ ExtractNodeAndLocalNames()

◆ get()

◆ getClassName()

◆ getName()

◆ getPeriodTime()

◆ getPluged()

◆ getReady()

◆ getTime()

◆ isPlugged()

◆ needUpdate()

◆ plug()

◆ recompute()

◆ removeDependency()

◆ set()

◆ setConstantDefault()

◆ setPeriodTime()

◆ setReady()

◆ setTime()

◆ shortName()

◆ trace()

◆ unplug()

◆ writeGraph()

Member Data Documentation

◆ name

◆ ready

◆ signalTime

template<class Time>
class dynamicgraph::SignalBase< Time >