This is the only type of signal that can be plugged to, using the plug () command. More...
#include <dynamic-graph/signal-ptr.h>
Public Member Functions | |
SignalPtr (Signal< T, Time > *ptr, std::string name="") | |
virtual | ~SignalPtr () |
Signal< T, Time > * | getPtr () |
const Signal< T, Time > * | getPtr () const |
SignalBase< Time > * | getAbstractPtr () |
const SignalBase< Time > * | getAbstractPtr () const |
virtual void | plug (SignalBase< Time > *ref) |
virtual void | unplug () |
virtual bool | isPluged () const |
virtual bool | isPlugged () const |
virtual SignalBase< Time > * | getPluged () const |
virtual bool | isAbstractPluged () const |
virtual const Time & | getTime () const |
Signal< T, Time > * | operator-> () |
const Signal< T, Time > * | operator-> () const |
Signal< T, Time > & | operator* () |
const Signal< T, Time > & | operator* () const |
operator bool () const | |
virtual bool | needUpdate (const Time &t) const |
virtual std::ostream & | writeGraph (std::ostream &os) const |
virtual std::ostream & | display (std::ostream &os) const |
virtual const T & | operator() (const Time &t) |
virtual const T & | access (const Time &t) |
virtual const T & | accessCopy () const |
void | setConstantDefault (const T &t) |
virtual void | setConstantDefault () |
void | unsetConstantDefault () |
virtual void | checkCompatibility () |
virtual void | setConstant (const T &t) |
virtual void | setReference (const T *t, typename Signal< T, Time >::Mutex *m=NULL) |
virtual void | setFunction (boost::function2< T &, T &, Time > t, typename Signal< T, Time >::Mutex *m=NULL) |
virtual Signal< T, Time > & | operator= (const T &t) |
virtual std::ostream & | displayDependencies (std::ostream &os, const int depth=-1, std::string space="", std::string next1="", std::string next2="") const |
Protected Member Functions | |
bool | autoref () const |
virtual void | addDependency () |
virtual void | removeDependency () |
virtual void | clearDependencies () |
Protected Attributes | |
Signal< T, Time > * | signalPtr |
bool | modeNoThrow |
bool | transmitAbstract |
SignalBase< Time > * | abstractTransmitter |
T * | transmitAbstractData |
This is the only type of signal that can be plugged to, using the plug () command.
In that sense, when plugged into, it acts as a "pointer" to the input signal, hence the name. Operator -> is also overloaded and can be used to access the pointed signal.
dynamicgraph::SignalPtr< T, Time >::SignalPtr | ( | Signal< T, Time > * | ptr, |
std::string | name = "" |
||
) | [inline] |
virtual dynamicgraph::SignalPtr< T, Time >::~SignalPtr | ( | ) | [inline, virtual] |
References dynamicgraph::SignalPtr< T, Time >::signalPtr.
const T & dynamicgraph::SignalPtr< T, Time >::access | ( | const Time & | t | ) | [virtual] |
Reimplemented from dynamicgraph::Signal< T, Time >.
References dynamicgraph::Signal< T, Time >::access(), dynamicgraph::Signal< T, Time >::accessCopy(), dgTDEBUGIN, and dgTDEBUGOUT.
const T & dynamicgraph::SignalPtr< T, Time >::accessCopy | ( | ) | const [virtual] |
Reimplemented from dynamicgraph::Signal< T, Time >.
References dynamicgraph::Signal< T, Time >::accessCopy().
Referenced by dynamicgraph::SignalPtr< T, Time >::setConstantDefault().
virtual void dynamicgraph::SignalPtr< T, Time >::addDependency | ( | ) | [inline, protected, virtual] |
bool dynamicgraph::SignalPtr< T, Time >::autoref | ( | ) | const [inline, protected] |
References dynamicgraph::SignalPtr< T, Time >::signalPtr.
void dynamicgraph::SignalPtr< T, Time >::checkCompatibility | ( | ) | [virtual] |
Reimplemented from dynamicgraph::Signal< T, Time >.
References dynamicgraph::Signal< T, Time >::checkCompatibility().
virtual void dynamicgraph::SignalPtr< T, Time >::clearDependencies | ( | ) | [inline, protected, virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
std::ostream & dynamicgraph::SignalPtr< T, Time >::display | ( | std::ostream & | os | ) | const [virtual] |
Reimplemented from dynamicgraph::Signal< T, Time >.
References dgTDEBUGIN, dgTDEBUGOUT, and dynamicgraph::Signal< T, Time >::display().
std::ostream & dynamicgraph::SignalPtr< T, Time >::displayDependencies | ( | std::ostream & | os, |
const int | depth = -1 , |
||
std::string | space = "" , |
||
std::string | next1 = "" , |
||
std::string | next2 = "" |
||
) | const [virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dgTDEBUGIN, dgTDEBUGOUT, and dynamicgraph::SignalBase< Time >::displayDependencies().
SignalBase< Time > * dynamicgraph::SignalPtr< T, Time >::getAbstractPtr | ( | ) |
References DG_THROW, and dynamicgraph::ExceptionSignal::NOT_INITIALIZED.
const SignalBase< Time > * dynamicgraph::SignalPtr< T, Time >::getAbstractPtr | ( | ) | const |
References DG_THROW, and dynamicgraph::ExceptionSignal::NOT_INITIALIZED.
virtual SignalBase<Time>* dynamicgraph::SignalPtr< T, Time >::getPluged | ( | ) | const [inline, virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalPtr< T, Time >::signalPtr.
Signal< T, Time > * dynamicgraph::SignalPtr< T, Time >::getPtr | ( | ) |
References DG_THROW, dgTDEBUGIN, dgTDEBUGOUT, and dynamicgraph::ExceptionSignal::NOT_INITIALIZED.
Referenced by dynamicgraph::SignalPtr< T, Time >::operator*(), and dynamicgraph::SignalPtr< T, Time >::operator->().
const Signal< T, Time > * dynamicgraph::SignalPtr< T, Time >::getPtr | ( | ) | const |
References DG_THROW, dgTDEBUGIN, dgTDEBUGOUT, and dynamicgraph::ExceptionSignal::NOT_INITIALIZED.
const Time & dynamicgraph::SignalPtr< T, Time >::getTime | ( | ) | const [virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalBase< Time >::getTime().
bool dynamicgraph::SignalPtr< T, Time >::isAbstractPluged | ( | ) | const [virtual] |
virtual bool dynamicgraph::SignalPtr< T, Time >::isPluged | ( | ) | const [inline, virtual] |
References dynamicgraph::SignalPtr< T, Time >::isPlugged().
virtual bool dynamicgraph::SignalPtr< T, Time >::isPlugged | ( | ) | const [inline, virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalPtr< T, Time >::signalPtr.
Referenced by dynamicgraph::SignalPtr< T, Time >::isPluged(), and dynamicgraph::SignalPtr< T, Time >::operator bool().
bool dynamicgraph::SignalPtr< T, Time >::needUpdate | ( | const Time & | t | ) | const [virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalBase< Time >::needUpdate().
dynamicgraph::SignalPtr< T, Time >::operator bool | ( | ) | const [inline] |
References dynamicgraph::SignalPtr< T, Time >::isPlugged().
const T & dynamicgraph::SignalPtr< T, Time >::operator() | ( | const Time & | t | ) | [virtual] |
Reimplemented from dynamicgraph::Signal< T, Time >.
Signal<T,Time>& dynamicgraph::SignalPtr< T, Time >::operator* | ( | ) | [inline] |
References dynamicgraph::SignalPtr< T, Time >::getPtr().
const Signal<T,Time>& dynamicgraph::SignalPtr< T, Time >::operator* | ( | ) | const [inline] |
References dynamicgraph::SignalPtr< T, Time >::getPtr().
Signal<T,Time>* dynamicgraph::SignalPtr< T, Time >::operator-> | ( | ) | [inline] |
References dynamicgraph::SignalPtr< T, Time >::getPtr().
const Signal<T,Time>* dynamicgraph::SignalPtr< T, Time >::operator-> | ( | ) | const [inline] |
References dynamicgraph::SignalPtr< T, Time >::getPtr().
virtual Signal<T,Time>& dynamicgraph::SignalPtr< T, Time >::operator= | ( | const T & | t | ) | [inline, virtual] |
Reimplemented from dynamicgraph::Signal< T, Time >.
References dynamicgraph::SignalPtr< T, Time >::setConstant().
void dynamicgraph::SignalPtr< T, Time >::plug | ( | SignalBase< Time > * | ref | ) | [virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalBase< Time >::checkCompatibility(), DG_THROW, dgTDEBUG, dgTDEBUGIN, dgTDEBUGOUT, dynamicgraph::SignalBase< Time >::getName(), dynamicgraph::ExceptionSignal::PLUG_IMPOSSIBLE, and dynamicgraph::Signal< T, Time >::setReference().
Referenced by dynamicgraph::SignalPtr< T, Time >::setConstant(), dynamicgraph::SignalPtr< T, Time >::setFunction(), dynamicgraph::SignalPtr< T, Time >::setReference(), and dynamicgraph::SignalPtr< T, Time >::unplug().
virtual void dynamicgraph::SignalPtr< T, Time >::removeDependency | ( | ) | [inline, protected, virtual] |
virtual void dynamicgraph::SignalPtr< T, Time >::setConstant | ( | const T & | t | ) | [inline, virtual] |
Reimplemented from dynamicgraph::Signal< T, Time >.
References dynamicgraph::SignalPtr< T, Time >::plug().
Referenced by dynamicgraph::SignalPtr< T, Time >::operator=(), and dynamicgraph::SignalPtr< T, Time >::setConstantDefault().
void dynamicgraph::SignalPtr< T, Time >::setConstantDefault | ( | const T & | t | ) | [inline] |
virtual void dynamicgraph::SignalPtr< T, Time >::setConstantDefault | ( | ) | [inline, virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalPtr< T, Time >::accessCopy(), and dynamicgraph::SignalPtr< T, Time >::setConstantDefault().
Referenced by dynamicgraph::SignalPtr< T, Time >::setConstantDefault().
virtual void dynamicgraph::SignalPtr< T, Time >::setFunction | ( | boost::function2< T &, T &, Time > | t, |
typename Signal< T, Time >::Mutex * | m = NULL |
||
) | [inline, virtual] |
References dynamicgraph::SignalPtr< T, Time >::plug().
virtual void dynamicgraph::SignalPtr< T, Time >::setReference | ( | const T * | t, |
typename Signal< T, Time >::Mutex * | m = NULL |
||
) | [inline, virtual] |
References dynamicgraph::SignalPtr< T, Time >::plug().
virtual void dynamicgraph::SignalPtr< T, Time >::unplug | ( | ) | [inline, virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalPtr< T, Time >::plug().
void dynamicgraph::SignalPtr< T, Time >::unsetConstantDefault | ( | ) | [inline] |
References dynamicgraph::SignalPtr< T, Time >::modeNoThrow.
std::ostream & dynamicgraph::SignalPtr< T, Time >::writeGraph | ( | std::ostream & | os | ) | const [virtual] |
Reimplemented from dynamicgraph::SignalBase< Time >.
References dynamicgraph::SignalBase< Time >::ExtractNodeAndLocalNames().
SignalBase<Time>* dynamicgraph::SignalPtr< T, Time >::abstractTransmitter [protected] |
bool dynamicgraph::SignalPtr< T, Time >::modeNoThrow [protected] |
Signal<T,Time>* dynamicgraph::SignalPtr< T, Time >::signalPtr [protected] |
bool dynamicgraph::SignalPtr< T, Time >::transmitAbstract [protected] |
T* dynamicgraph::SignalPtr< T, Time >::transmitAbstractData [protected] |