The base class for signals: not to be used as such. More...
#include <dynamic-graph/signal-base.h>
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 |
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'.
dynamicgraph::SignalBase< Time >::SignalBase | ( | std::string | name = "" | ) | [inline, explicit] |
virtual dynamicgraph::SignalBase< Time >::~SignalBase | ( | ) | [inline, virtual] |
virtual void dynamicgraph::SignalBase< Time >::addDependency | ( | const SignalBase< Time > & | ) | [inline, virtual] |
Reimplemented in dynamicgraph::SignalTimeDependent< T, Time >.
virtual void dynamicgraph::SignalBase< Time >::checkCompatibility | ( | ) | [inline, virtual] |
Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, and dynamicgraph::SignalPtr< T, Time >.
Referenced by dynamicgraph::SignalPtr< T, Time >::plug().
virtual void dynamicgraph::SignalBase< Time >::clearDependencies | ( | ) | [inline, virtual] |
virtual std::ostream& dynamicgraph::SignalBase< Time >::display | ( | std::ostream & | os | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::Signal< T, Time >, dynamicgraph::Signal< int, int >, and dynamicgraph::SignalPtr< T, Time >.
Referenced by dynamicgraph::SignalBase< int >::displayDependencies().
virtual std::ostream& dynamicgraph::SignalBase< Time >::displayDependencies | ( | std::ostream & | os, |
const int | = -1 , |
||
std::string | space = "" , |
||
std::string | next1 = "" , |
||
std::string | = "" |
||
) | const [inline, virtual] |
virtual void dynamicgraph::SignalBase< Time >::ExtractNodeAndLocalNames | ( | std::string & | LocalName, |
std::string & | NodeName | ||
) | const [inline, virtual] |
Referenced by dynamicgraph::SignalPtr< T, Time >::writeGraph().
virtual void dynamicgraph::SignalBase< Time >::get | ( | std::ostream & | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::Signal< T, Time >, and dynamicgraph::Signal< int, int >.
void dynamicgraph::SignalBase< Time >::getClassName | ( | std::string & | aClassName | ) | const [inline] |
Reimplemented in dynamicgraph::Signal< T, Time >, and dynamicgraph::Signal< int, int >.
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().
virtual Time dynamicgraph::SignalBase< Time >::getPeriodTime | ( | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::SignalTimeDependent< T, Time >, and dynamicgraph::SignalTimeDependent< int, int >.
virtual SignalBase<Time>* dynamicgraph::SignalBase< Time >::getPluged | ( | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::SignalPtr< T, Time >.
const bool& dynamicgraph::SignalBase< Time >::getReady | ( | ) | const [inline] |
virtual const Time& dynamicgraph::SignalBase< Time >::getTime | ( | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::SignalPtr< T, Time >.
Referenced by dynamicgraph::SignalPtr< T, Time >::getTime(), and dynamicgraph::TimeDependency< Time >::needUpdate().
virtual bool dynamicgraph::SignalBase< Time >::isPlugged | ( | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::SignalPtr< T, Time >.
virtual bool dynamicgraph::SignalBase< Time >::needUpdate | ( | const Time & | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::SignalPtr< T, Time >, and dynamicgraph::SignalTimeDependent< T, Time >.
Referenced by dynamicgraph::TimeDependency< Time >::needUpdate(), and dynamicgraph::SignalPtr< T, Time >::needUpdate().
virtual void dynamicgraph::SignalBase< Time >::plug | ( | SignalBase< Time > * | sigarg | ) | [inline, virtual] |
Reimplemented in dynamicgraph::SignalPtr< T, Time >.
virtual void dynamicgraph::SignalBase< Time >::recompute | ( | const Time & | ) | [inline, virtual] |
Reimplemented in dynamicgraph::Signal< T, Time >, and dynamicgraph::Signal< int, int >.
virtual void dynamicgraph::SignalBase< Time >::removeDependency | ( | const SignalBase< Time > & | ) | [inline, virtual] |
Reimplemented in dynamicgraph::SignalTimeDependent< T, Time >.
virtual void dynamicgraph::SignalBase< Time >::set | ( | std::istringstream & | ) | [inline, virtual] |
Reimplemented in dynamicgraph::Signal< T, Time >, and dynamicgraph::Signal< int, int >.
virtual void dynamicgraph::SignalBase< Time >::setConstantDefault | ( | ) | [inline, virtual] |
Reimplemented in dynamicgraph::SignalPtr< T, Time >.
virtual void dynamicgraph::SignalBase< Time >::setPeriodTime | ( | const Time & | ) | [inline, virtual] |
Reimplemented in dynamicgraph::SignalTimeDependent< T, Time >.
void dynamicgraph::SignalBase< Time >::setReady | ( | const bool | sready = true | ) | [inline] |
Referenced by dynamicgraph::SignalTimeDependent< T, Time >::access().
virtual void dynamicgraph::SignalBase< Time >::setTime | ( | const Time & | t | ) | [inline, virtual] |
std::string dynamicgraph::SignalBase< Time >::shortName | ( | ) | const [inline] |
virtual void dynamicgraph::SignalBase< Time >::trace | ( | std::ostream & | ) | const [inline, virtual] |
Reimplemented in dynamicgraph::Signal< T, Time >, and dynamicgraph::Signal< int, int >.
virtual void dynamicgraph::SignalBase< Time >::unplug | ( | ) | [inline, virtual] |
Reimplemented in dynamicgraph::SignalPtr< T, Time >.
virtual std::ostream& dynamicgraph::SignalBase< Time >::writeGraph | ( | std::ostream & | os | ) | const [inline, virtual] |
std::string dynamicgraph::SignalBase< Time >::name [protected] |
bool dynamicgraph::SignalBase< Time >::ready [protected] |
Time dynamicgraph::SignalBase< Time >::signalTime [protected] |
Referenced by dynamicgraph::SignalBase< int >::getTime(), and dynamicgraph::SignalBase< int >::setTime().