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

#include <dynamic-graph/signal-base.h>

Inheritance diagram for dynamicgraph::SignalBase< Time >:

Collaboration 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

Time	signalTime

bool	ready

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

Constructor & Destructor Documentation

◆ SignalBase()

template<class Time>

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

inlineexplicit

◆ ~SignalBase()

template<class Time>

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

inlinevirtual

Member Function Documentation

◆ addDependency()

template<class Time>

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

inlinevirtual

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

◆ checkCompatibility()

template<class Time>

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

inlinevirtual

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

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

◆ clearDependencies()

template<class Time>

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

inlinevirtual

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

◆ 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 >, and dynamicgraph::SignalPtr< T, Time >.

Referenced by dynamicgraph::SignalBase< int >::displayDependencies().

◆ 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::SignalTimeDependent< T, Time >, and dynamicgraph::SignalTimeDependent< int, int >.

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

◆ ExtractNodeAndLocalNames()

template<class Time>

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

inlinevirtual

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

◆ get()

template<class Time>

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

inlinevirtual

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

◆ getClassName()

template<class Time>

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

inline

◆ getName()

template<class Time>

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

inline

Referenced by dynamicgraph::SignalBase< int >::checkCompatibility(), dynamicgraph::SignalBase< int >::ExtractNodeAndLocalNames(), dynamicgraph::SignalBase< int >::get(), dynamicgraph::SignalPtr< T, Time >::plug(), dynamicgraph::SignalBase< int >::plug(), dynamicgraph::SignalBase< int >::recompute(), dynamicgraph::SignalBase< int >::set(), dynamicgraph::SignalBase< int >::setConstantDefault(), dynamicgraph::SignalBase< int >::trace(), and dynamicgraph::SignalBase< int >::unplug().

◆ getPeriodTime()

template<class Time>

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

inlinevirtual

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

◆ getPluged()

template<class Time>

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

inlinevirtual

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

◆ getReady()

template<class Time>

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

inline

◆ getTime()

template<class Time>

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

inlinevirtual

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

Referenced by dynamicgraph::SignalPtr< T, Time >::getTime(), and dynamicgraph::TimeDependency< int >::needUpdate().

◆ isPlugged()

template<class Time>

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

inlinevirtual

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

◆ needUpdate()

template<class Time>

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

inlinevirtual

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

Referenced by dynamicgraph::TimeDependency< int >::needUpdate(), and dynamicgraph::SignalPtr< T, Time >::needUpdate().

◆ plug()

template<class Time>

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

inlinevirtual

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

◆ recompute()

template<class Time>

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

inlinevirtual

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

◆ removeDependency()

template<class Time>

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

inlinevirtual

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

◆ set()

template<class Time>

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

inlinevirtual

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

◆ setConstantDefault()

template<class Time>

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

inlinevirtual

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

◆ setPeriodTime()

template<class Time>

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

inlinevirtual

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

◆ setReady()

template<class Time>

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

inline

◆ setTime()

template<class Time>

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

inlinevirtual

◆ shortName()

template<class Time>

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

inline

◆ trace()

template<class Time>

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

inlinevirtual

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

◆ unplug()

template<class Time>

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

inlinevirtual

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

◆ 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 >, and dynamicgraph::SignalPtr< T, Time >.

Member Data Documentation

◆ name

template<class Time>

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

protected

Referenced by dynamicgraph::SignalBase< int >::display(), dynamicgraph::SignalBase< int >::getClassName(), dynamicgraph::Signal< int, int >::getClassName(), dynamicgraph::SignalBase< int >::getName(), and dynamicgraph::SignalBase< int >::shortName().

◆ ready

template<class Time>

bool dynamicgraph::SignalBase< Time >::ready

protected

Referenced by dynamicgraph::SignalBase< int >::getReady(), dynamicgraph::SignalBase< int >::needUpdate(), and dynamicgraph::SignalBase< int >::setReady().

◆ signalTime

template<class Time>

Time dynamicgraph::SignalBase< Time >::signalTime

protected

Referenced by dynamicgraph::SignalBase< int >::getTime(), and dynamicgraph::SignalBase< int >::setTime().

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 >