Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dynamicgraph::SignalPtr< T, Time > Class Template Reference
Core classes and objects

This is the only type of signal that can be plugged to, using the plug () command. More...

#include <fwd.hh>

Public Member Functions

virtual const T & access (const Time &t)
 
virtual const T & accessCopy () const
 
virtual std::ostream & display (std::ostream &os) const
 
virtual std::ostream & displayDependencies (std::ostream &os, const int depth=-1, std::string space="", std::string next1="", std::string next2="") const
 
virtual SignalBase< Time > * getPluged () const
 
Signal< T, Time > * getPtr ()
 
const Signal< T, Time > * getPtr () const
 
virtual const Time & getTime () const
 
virtual bool isPlugged () const
 
virtual bool needUpdate (const Time &t) const
 
 operator bool () const
 
virtual const T & operator() (const Time &t)
 
Signal< T, Time > & operator* ()
 
const Signal< T, Time > & operator* () const
 
Signal< T, Time > * operator-> ()
 
const Signal< T, Time > * operator-> () const
 
virtual Signal< T, Time > & operator= (const T &t)
 
virtual void plug (SignalBase< Time > *ref)
 
virtual void setConstant (const T &t)
 
virtual void setConstantDefault ()
 
void setConstantDefault (const T &t)
 
virtual void setFunction (boost::function2< T &, T &, Time > t, typename Signal< T, Time >::Mutex *m=NULL)
 
virtual void setReference (const T *t, typename Signal< T, Time >::Mutex *m=NULL)
 
 SignalPtr (Signal< T, Time > *ptr, std::string name="")
 
virtual void unplug ()
 
void unsetConstantDefault ()
 
virtual std::ostream & writeGraph (std::ostream &os) const
 
virtual ~SignalPtr ()
 

Protected Member Functions

virtual void addDependency ()
 
bool autoref () const
 
virtual void clearDependencies ()
 
virtual void removeDependency ()
 

Protected Attributes

SignalBase< Time > * abstractTransmitter
 
bool modeNoThrow
 
Signal< T, Time > * signalPtr
 
T * transmitAbstractData
 

Detailed Description

template<class T, class Time>
class dynamicgraph::SignalPtr< T, Time >

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.

If the signal provided as a parameter of the plug operation cannot be casted in type T, but is compatible then the class holds a reference to an abstract object.

Definition at line 56 of file fwd.hh.

Constructor & Destructor Documentation

◆ SignalPtr()

template<class T , class Time >
dynamicgraph::SignalPtr< T, Time >::SignalPtr ( Signal< T, Time > *  ptr,
std::string  name = "" 
)
inline

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

◆ ~SignalPtr()

template<class T , class Time >
virtual dynamicgraph::SignalPtr< T, Time >::~SignalPtr ( )
inlinevirtual

Definition at line 46 of file signal-ptr.h.

Member Function Documentation

◆ access()

template<class T , class Time >
const T & dynamicgraph::SignalPtr< T, Time >::access ( const Time &  t)
virtual

Definition at line 82 of file signal-ptr.t.cpp.

◆ accessCopy()

template<class T , class Time >
const T & dynamicgraph::SignalPtr< T, Time >::accessCopy
virtual

Definition at line 97 of file signal-ptr.t.cpp.

◆ addDependency()

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::addDependency ( )
inlineprotectedvirtual

Definition at line 127 of file signal-ptr.h.

◆ autoref()

template<class T , class Time >
bool dynamicgraph::SignalPtr< T, Time >::autoref ( ) const
inlineprotected

Definition at line 37 of file signal-ptr.h.

◆ clearDependencies()

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::clearDependencies ( )
inlineprotectedvirtual

Definition at line 130 of file signal-ptr.h.

◆ display()

template<class T , class Time >
std::ostream & dynamicgraph::SignalPtr< T, Time >::display ( std::ostream &  os) const
virtual

Definition at line 122 of file signal-ptr.t.cpp.

◆ displayDependencies()

template<class T , class Time >
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

Definition at line 141 of file signal-ptr.t.cpp.

◆ getPluged()

template<class T , class Time >
virtual SignalBase<Time>* dynamicgraph::SignalPtr< T, Time >::getPluged ( ) const
inlinevirtual

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

◆ getPtr() [1/2]

template<class T , class Time >
const Signal< T, Time > * dynamicgraph::SignalPtr< T, Time >::getPtr

Definition at line 16 of file signal-ptr.t.cpp.

◆ getPtr() [2/2]

template<class T , class Time >
const Signal<T, Time>* dynamicgraph::SignalPtr< T, Time >::getPtr ( ) const

◆ getTime()

template<class T , class Time >
const Time & dynamicgraph::SignalPtr< T, Time >::getTime
virtual

Definition at line 69 of file signal-ptr.t.cpp.

◆ isPlugged()

template<class T , class Time >
virtual bool dynamicgraph::SignalPtr< T, Time >::isPlugged ( ) const
inlinevirtual

Definition at line 56 of file signal-ptr.h.

◆ needUpdate()

template<class T , class Time >
bool dynamicgraph::SignalPtr< T, Time >::needUpdate ( const Time &  t) const
virtual

Definition at line 61 of file signal-ptr.t.cpp.

◆ operator bool()

template<class T , class Time >
dynamicgraph::SignalPtr< T, Time >::operator bool ( ) const
inline

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

◆ operator()()

template<class T , class Time >
const T & dynamicgraph::SignalPtr< T, Time >::operator() ( const Time &  t)
virtual

Definition at line 77 of file signal-ptr.t.cpp.

◆ operator*() [1/2]

template<class T , class Time >
Signal<T, Time>& dynamicgraph::SignalPtr< T, Time >::operator* ( )
inline

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

◆ operator*() [2/2]

template<class T , class Time >
const Signal<T, Time>& dynamicgraph::SignalPtr< T, Time >::operator* ( ) const
inline

Definition at line 64 of file signal-ptr.h.

◆ operator->() [1/2]

template<class T , class Time >
Signal<T, Time>* dynamicgraph::SignalPtr< T, Time >::operator-> ( )
inline

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

◆ operator->() [2/2]

template<class T , class Time >
const Signal<T, Time>* dynamicgraph::SignalPtr< T, Time >::operator-> ( ) const
inline

Definition at line 62 of file signal-ptr.h.

◆ operator=()

template<class T , class Time >
virtual Signal<T, Time>& dynamicgraph::SignalPtr< T, Time >::operator= ( const T &  t)
inlinevirtual

Definition at line 114 of file signal-ptr.h.

◆ plug()

template<class T , class Time >
void dynamicgraph::SignalPtr< T, Time >::plug ( SignalBase< Time > *  ref)
virtual

Definition at line 41 of file signal-ptr.t.cpp.

◆ removeDependency()

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::removeDependency ( )
inlineprotectedvirtual

Definition at line 129 of file signal-ptr.h.

◆ setConstant()

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::setConstant ( const T &  t)
inlinevirtual

Definition at line 94 of file signal-ptr.h.

◆ setConstantDefault() [1/2]

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::setConstantDefault ( )
inlinevirtual

Definition at line 86 of file signal-ptr.h.

◆ setConstantDefault() [2/2]

template<class T , class Time >
void dynamicgraph::SignalPtr< T, Time >::setConstantDefault ( const T &  t)
inline

Definition at line 82 of file signal-ptr.h.

◆ setFunction()

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::setFunction ( boost::function2< T &, T &, Time >  t,
typename Signal< T, Time >::Mutex *  m = NULL 
)
inlinevirtual

Definition at line 103 of file signal-ptr.h.

◆ setReference()

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::setReference ( const T *  t,
typename Signal< T, Time >::Mutex *  m = NULL 
)
inlinevirtual

Definition at line 98 of file signal-ptr.h.

◆ unplug()

template<class T , class Time >
virtual void dynamicgraph::SignalPtr< T, Time >::unplug ( )
inlinevirtual

Definition at line 54 of file signal-ptr.h.

◆ unsetConstantDefault()

template<class T , class Time >
void dynamicgraph::SignalPtr< T, Time >::unsetConstantDefault ( )
inline

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

◆ writeGraph()

template<class T , class Time >
std::ostream & dynamicgraph::SignalPtr< T, Time >::writeGraph ( std::ostream &  os) const
virtual

Definition at line 106 of file signal-ptr.t.cpp.

Member Data Documentation

◆ abstractTransmitter

template<class T , class Time >
SignalBase<Time>* dynamicgraph::SignalPtr< T, Time >::abstractTransmitter
protected

Definition at line 34 of file signal-ptr.h.

◆ modeNoThrow

template<class T , class Time >
bool dynamicgraph::SignalPtr< T, Time >::modeNoThrow
protected

Definition at line 33 of file signal-ptr.h.

◆ signalPtr

template<class T , class Time >
Signal<T, Time>* dynamicgraph::SignalPtr< T, Time >::signalPtr
protected

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

◆ transmitAbstractData

template<class T , class Time >
T* dynamicgraph::SignalPtr< T, Time >::transmitAbstractData
protected

Definition at line 35 of file signal-ptr.h.

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

dynamic-graph
Author(s): Nicolas Mansard, Olivier Stasse
autogenerated on Fri Aug 2 2024 08:36:39