All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 >:
[legend]
Collaboration diagram for dynamicgraph::TimeDependency< Time >:
[legend]

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<typename Time>
class dynamicgraph::TimeDependency< Time >

A helper class for setting and specifying dependencies between signals.

Member Typedef Documentation

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

Member Enumeration Documentation

template<typename Time>
enum dynamicgraph::TimeDependency::DependencyType
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<typename Time>
virtual dynamicgraph::TimeDependency< Time >::~TimeDependency ( )
inlinevirtual

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<typename Time>
bool dynamicgraph::TimeDependency< Time >::getNeedUpdateFromAllChildren ( ) const
inline
template<typename Time>
Time dynamicgraph::TimeDependency< Time >::getPeriodTime ( ) const
inline
template<class Time>
void dynamicgraph::TimeDependency< Time >::removeDependency ( const SignalBase< Time > &  sig)
template<typename Time>
void dynamicgraph::TimeDependency< Time >::setDependencyType ( DependencyType  dep)
inline
template<typename Time>
void dynamicgraph::TimeDependency< Time >::setNeedUpdateFromAllChildren ( const bool  b = true)
inline
template<typename 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<typename Time>
const bool dynamicgraph::TimeDependency< Time >::ALL_READY_DEFAULT = false
static
template<typename Time>
Dependencies dynamicgraph::TimeDependency< Time >::dependencies
template<typename Time>
const DependencyType dynamicgraph::TimeDependency< Time >::DEPENDENCY_TYPE_DEFAULT = TIME_DEPENDENT
static
template<typename Time>
DependencyType dynamicgraph::TimeDependency< Time >::dependencyType
template<typename Time>
Time dynamicgraph::TimeDependency< Time >::lastAskForUpdate
mutable
template<typename Time>
SignalBase< Time >& dynamicgraph::TimeDependency< Time >::leader
template<typename Time>
const Time dynamicgraph::TimeDependency< Time >::PERIOD_TIME_DEFAULT = 1
static