Loading...
Searching...
No Matches
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<class Time>
class dynamicgraph::TimeDependency< Time >

A helper class for setting and specifying dependencies between signals.

Member Typedef Documentation

◆ Dependencies

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

Member Enumeration Documentation

◆ DependencyType

template<class Time>
enum dynamicgraph::TimeDependency::DependencyType
Enumerator
TIME_DEPENDENT 
BOOL_DEPENDENT 
ALWAYS_READY 

Constructor & Destructor Documentation

◆ TimeDependency() [1/2]

template<class Time>
dynamicgraph::TimeDependency< Time >::TimeDependency ( SignalBase< Time > * sig,
const DependencyType dep = DEPENDENCY_TYPE_DEFAULT )

References __TIME_DEPENDENCY_INIT.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::SignalTimeDependent(), dynamicgraph::SignalTimeDependent< T, Time >::SignalTimeDependent(), and dynamicgraph::SignalTimeDependent< T, Time >::SignalTimeDependent().

◆ TimeDependency() [2/2]

template<class Time>
dynamicgraph::TimeDependency< Time >::TimeDependency ( SignalBase< Time > * sig,
const SignalArray_const< Time > & arr,
const DependencyType dep = DEPENDENCY_TYPE_DEFAULT )

References __TIME_DEPENDENCY_INIT, addDependency(), and dynamicgraph::SignalArray_const< Time >::getSize().

◆ ~TimeDependency()

template<class Time>
virtual dynamicgraph::TimeDependency< Time >::~TimeDependency ( )
inlinevirtual

Member Function Documentation

◆ addDependency()

template<class Time>
void dynamicgraph::TimeDependency< Time >::addDependency ( const SignalBase< Time > & sig)

References dependencies.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::addDependency(), and TimeDependency().

◆ clearDependency()

template<class Time>
void dynamicgraph::TimeDependency< Time >::clearDependency ( )

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::clearDependencies().

◆ displayDependencies()

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

References ALWAYS_READY, BOOL_DEPENDENT, dependencies, dependencyType, leader, periodTime, and TIME_DEPENDENT.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::displayDependencies().

◆ getNeedUpdateFromAllChildren()

template<class Time>
bool dynamicgraph::TimeDependency< Time >::getNeedUpdateFromAllChildren ( ) const
inline

References updateFromAllChildren.

◆ getPeriodTime()

template<class Time>
Time dynamicgraph::TimeDependency< Time >::getPeriodTime ( ) const
inline

References periodTime.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::getPeriodTime().

◆ needUpdate()

template<class Time>
bool dynamicgraph::TimeDependency< Time >::needUpdate ( const Time & t1) const

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::access(), and dynamicgraph::SignalTimeDependent< T, Time >::needUpdate().

◆ removeDependency()

template<class Time>
void dynamicgraph::TimeDependency< Time >::removeDependency ( const SignalBase< Time > & sig)

References dependencies.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::removeDependency().

◆ setDependencyType()

template<class Time>
void dynamicgraph::TimeDependency< Time >::setDependencyType ( DependencyType dep)
inline

References dependencyType.

◆ setNeedUpdateFromAllChildren()

template<class Time>
void dynamicgraph::TimeDependency< Time >::setNeedUpdateFromAllChildren ( const bool b = true)
inline

References updateFromAllChildren.

◆ setPeriodTime()

template<class Time>
void dynamicgraph::TimeDependency< Time >::setPeriodTime ( const Time & p)
inline

References periodTime.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::setPeriodTime().

◆ writeGraph()

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

Reimplemented in dynamicgraph::SignalTimeDependent< T, Time >, and dynamicgraph::SignalTimeDependent< int, int >.

References dependencies, and leader.

Member Data Documentation

◆ ALL_READY_DEFAULT

template<class Time>
const bool dynamicgraph::TimeDependency< Time >::ALL_READY_DEFAULT = false
static

◆ dependencies

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

Referenced by addDependency(), displayDependencies(), removeDependency(), and writeGraph().

◆ DEPENDENCY_TYPE_DEFAULT

template<class Time>
const DependencyType dynamicgraph::TimeDependency< Time >::DEPENDENCY_TYPE_DEFAULT = TIME_DEPENDENT
static

◆ dependencyType

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

Referenced by displayDependencies(), and setDependencyType().

◆ lastAskForUpdate

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

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::access().

◆ leader

template<class Time>
SignalBase< Time >& dynamicgraph::TimeDependency< Time >::leader

Referenced by displayDependencies(), and writeGraph().

◆ PERIOD_TIME_DEFAULT

template<class Time>
const Time dynamicgraph::TimeDependency< Time >::PERIOD_TIME_DEFAULT = 1
static

◆ periodTime

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

Referenced by displayDependencies(), getPeriodTime(), and setPeriodTime().

◆ updateFromAllChildren

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

Referenced by getNeedUpdateFromAllChildren(), and setNeedUpdateFromAllChildren().