All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dynamicgraph::SignalBase< Time > Class Template Reference

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

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

Inheritance diagram for dynamicgraph::SignalBase< Time >:
[legend]
Collaboration diagram for dynamicgraph::SignalBase< Time >:
[legend]

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

template<typename Time>
dynamicgraph::SignalBase< Time >::SignalBase ( std::string  name = "")
inlineexplicit
template<typename Time>
virtual dynamicgraph::SignalBase< Time >::~SignalBase ( )
inlinevirtual

Member Function Documentation

template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::addDependency ( const SignalBase< Time > &  )
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::checkCompatibility ( )
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::clearDependencies ( )
inlinevirtual
template<typename Time>
virtual std::ostream& dynamicgraph::SignalBase< Time >::display ( std::ostream &  os) const
inlinevirtual
template<typename Time>
virtual std::ostream& dynamicgraph::SignalBase< Time >::displayDependencies ( std::ostream &  os,
const int  = -1,
std::string  space = "",
std::string  next1 = "",
std::string  = "" 
) const
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::ExtractNodeAndLocalNames ( std::string &  LocalName,
std::string &  NodeName 
) const
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::get ( std::ostream &  ) const
inlinevirtual
template<typename Time>
void dynamicgraph::SignalBase< Time >::getClassName ( std::string &  aClassName) const
inline
template<typename Time>
virtual Time dynamicgraph::SignalBase< Time >::getPeriodTime ( ) const
inlinevirtual
template<typename Time>
virtual SignalBase<Time>* dynamicgraph::SignalBase< Time >::getPluged ( ) const
inlinevirtual
template<typename Time>
const bool& dynamicgraph::SignalBase< Time >::getReady ( ) const
inline
template<typename Time>
virtual const Time& dynamicgraph::SignalBase< Time >::getTime ( ) const
inlinevirtual
template<typename Time>
virtual bool dynamicgraph::SignalBase< Time >::isPlugged ( ) const
inlinevirtual
template<typename Time>
virtual bool dynamicgraph::SignalBase< Time >::needUpdate ( const Time &  ) const
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::plug ( SignalBase< Time > *  sigarg)
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::recompute ( const Time &  )
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::removeDependency ( const SignalBase< Time > &  )
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::set ( std::istringstream &  )
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::setConstantDefault ( )
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::setPeriodTime ( const Time &  )
inlinevirtual
template<typename Time>
void dynamicgraph::SignalBase< Time >::setReady ( const bool  sready = true)
inline
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::setTime ( const Time &  t)
inlinevirtual
template<typename Time>
std::string dynamicgraph::SignalBase< Time >::shortName ( ) const
inline
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::trace ( std::ostream &  ) const
inlinevirtual
template<typename Time>
virtual void dynamicgraph::SignalBase< Time >::unplug ( )
inlinevirtual
template<typename Time>
virtual std::ostream& dynamicgraph::SignalBase< Time >::writeGraph ( std::ostream &  os) const
inlinevirtual

Member Data Documentation

template<typename Time>
Time dynamicgraph::SignalBase< Time >::signalTime
protected