dynamicgraph::TimeDependency< Time > Class Template Reference

A helper class for setting and specifying dependencies between signals. More...

#include <dynamic-graph/time-dependency.h>

Inheritance diagram for dynamicgraph::TimeDependency< Time >:
Collaboration diagram for dynamicgraph::TimeDependency< Time >:

List of all members.

Public Types

enum  DependencyType {
  TIME_DEPENDENT,
  BOOL_DEPENDENT,
  ALWAYS_READY
}
typedef std::list< const
SignalBase< Time > * > 
Dependencies

Public Member Functions

 TimeDependency (SignalBase< Time > *sig, const DependencyType dep=DEPENDENCY_TYPE_DEFAULT)
 TimeDependency (SignalBase< Time > *sig, const SignalArray_const< Time > &arr, const DependencyType dep=DEPENDENCY_TYPE_DEFAULT)
virtual ~TimeDependency ()
void addDependency (const SignalBase< Time > &sig)
void removeDependency (const SignalBase< Time > &sig)
void clearDependency ()
virtual std::ostream & writeGraph (std::ostream &os) const
std::ostream & displayDependencies (std::ostream &os, const int depth=-1, std::string space="", std::string next1="", std::string next2="") const
bool needUpdate (const Time &t1) const
void setDependencyType (DependencyType dep)
void setNeedUpdateFromAllChildren (const bool b=true)
bool getNeedUpdateFromAllChildren () const
void setPeriodTime (const Time &p)
Time getPeriodTime () const

Public Attributes

Time lastAskForUpdate
SignalBase< Time > & leader
Dependencies dependencies
bool updateFromAllChildren
DependencyType dependencyType
Time periodTime

Static Public Attributes

static const DependencyType DEPENDENCY_TYPE_DEFAULT = TIME_DEPENDENT
static const bool ALL_READY_DEFAULT = false
static const Time PERIOD_TIME_DEFAULT = 1

Detailed Description

template<class Time>
class dynamicgraph::TimeDependency< Time >

A helper class for setting and specifying dependencies between signals.


Member Typedef Documentation

template<class Time>
typedef std::list< const SignalBase<Time> * > dynamicgraph::TimeDependency< Time >::Dependencies

Member Enumeration Documentation

Enumerator:
TIME_DEPENDENT 
BOOL_DEPENDENT 
ALWAYS_READY 

Constructor & Destructor Documentation

template<class Time>
dynamicgraph::TimeDependency< Time >::TimeDependency ( SignalBase< Time > *  sig,
const DependencyType  dep = DEPENDENCY_TYPE_DEFAULT 
)
template<class Time>
virtual dynamicgraph::TimeDependency< Time >::~TimeDependency ( ) [inline, virtual]

Member Function Documentation

template<class Time >
void dynamicgraph::TimeDependency< Time >::clearDependency ( )
template<class Time >
std::ostream & dynamicgraph::TimeDependency< Time >::displayDependencies ( std::ostream &  os,
const int  depth = -1,
std::string  space = "",
std::string  next1 = "",
std::string  next2 = "" 
) const
template<class Time>
bool dynamicgraph::TimeDependency< Time >::getNeedUpdateFromAllChildren ( ) const [inline]
template<class Time>
void dynamicgraph::TimeDependency< Time >::setDependencyType ( DependencyType  dep) [inline]
template<class Time>
void dynamicgraph::TimeDependency< Time >::setNeedUpdateFromAllChildren ( const bool  b = true) [inline]
template<class Time>
void dynamicgraph::TimeDependency< Time >::setPeriodTime ( const Time &  p) [inline]
template<class Time >
std::ostream & dynamicgraph::TimeDependency< Time >::writeGraph ( std::ostream &  os) const [virtual]

Member Data Documentation

template<class Time>
const bool dynamicgraph::TimeDependency< Time >::ALL_READY_DEFAULT = false [static]
template<class Time>
const DependencyType dynamicgraph::TimeDependency< Time >::DEPENDENCY_TYPE_DEFAULT = TIME_DEPENDENT [static]
template<class Time>
Time dynamicgraph::TimeDependency< Time >::lastAskForUpdate [mutable]
template<class Time>
SignalBase< Time >& dynamicgraph::TimeDependency< Time >::leader
template<class Time>
const Time dynamicgraph::TimeDependency< Time >::PERIOD_TIME_DEFAULT = 1 [static]