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

#include <fwd.hh>

Public Types
typedef std::list< const SignalBase< Time > * >	Dependencies

enum	DependencyType { TIME_DEPENDENT, BOOL_DEPENDENT, ALWAYS_READY }

Public Member Functions
void	addDependencies (const SignalArray_const< Time > &arr)

void	addDependency (const SignalBase< Time > &sig)

void	clearDependency ()

std::ostream &	displayDependencies (std::ostream &os, const int depth=-1, std::string space="", std::string next1="", std::string next2="") const

bool	getNeedUpdateFromAllChildren () const

Time	getPeriodTime () const

bool	needUpdate (const Time &t1) const

void	removeDependency (const SignalBase< Time > &sig)

void	setDependencyType (DependencyType dep)

void	setNeedUpdateFromAllChildren (const bool b=true)

void	setPeriodTime (const Time &p)

	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 std::ostream &	writeGraph (std::ostream &os) const

virtual	~TimeDependency ()

Public Attributes
Dependencies	dependencies

DependencyType	dependencyType

Time	lastAskForUpdate

SignalBase< Time > &	leader

Time	periodTime

bool	updateFromAllChildren

Static Public Attributes
static const bool	ALL_READY_DEFAULT = false

static const DependencyType	DEPENDENCY_TYPE_DEFAULT = TIME_DEPENDENT

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.

Definition at line 60 of file fwd.hh.

Member Typedef Documentation

◆ Dependencies

template<class Time >

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

Definition at line 28 of file time-dependency.h.

Member Enumeration Documentation

◆ DependencyType

template<class Time >

enum dynamicgraph::TimeDependency::DependencyType

Enumerator
TIME_DEPENDENT
BOOL_DEPENDENT
ALWAYS_READY

Definition at line 21 of file time-dependency.h.

Constructor & Destructor Documentation

◆ TimeDependency() [1/2]

template<class Time >

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

Definition at line 20 of file time-dependency.t.cpp.

◆ TimeDependency() [2/2]

template<class Time >

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

Definition at line 25 of file time-dependency.t.cpp.

◆ ~TimeDependency()

template<class Time >

virtual dynamicgraph::TimeDependency< Time >::~TimeDependency ( )

inlinevirtual

Definition at line 45 of file time-dependency.h.

Member Function Documentation

◆ addDependencies()

template<class Time >

void dynamicgraph::TimeDependency< Time >::addDependencies ( const SignalArray_const< Time > & arr )

Definition at line 36 of file time-dependency.t.cpp.

◆ addDependency()

template<class Time >

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

Definition at line 43 of file time-dependency.t.cpp.

◆ clearDependency()

template<class Time >

void dynamicgraph::TimeDependency< Time >::clearDependency

Definition at line 53 of file time-dependency.t.cpp.

◆ 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

Definition at line 121 of file time-dependency.t.cpp.

◆ getNeedUpdateFromAllChildren()

template<class Time >

bool dynamicgraph::TimeDependency< Time >::getNeedUpdateFromAllChildren ( ) const

inline

Definition at line 65 of file time-dependency.h.

◆ getPeriodTime()

template<class Time >

Time dynamicgraph::TimeDependency< Time >::getPeriodTime ( ) const

inline

Definition at line 68 of file time-dependency.h.

◆ needUpdate()

template<class Time >

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

Definition at line 58 of file time-dependency.t.cpp.

◆ removeDependency()

template<class Time >

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

Definition at line 48 of file time-dependency.t.cpp.

◆ setDependencyType()

template<class Time >

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

inline

Definition at line 60 of file time-dependency.h.

◆ setNeedUpdateFromAllChildren()

template<class Time >

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

inline

Definition at line 62 of file time-dependency.h.

◆ setPeriodTime()

template<class Time >

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

inline

Definition at line 67 of file time-dependency.h.

◆ writeGraph()

template<class Time >

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

virtual

Definition at line 116 of file time-dependency.t.cpp.

Member Data Documentation

◆ ALL_READY_DEFAULT

template<class Time >

const bool dynamicgraph::TimeDependency< Time >::ALL_READY_DEFAULT = false

static

Definition at line 33 of file time-dependency.h.

◆ dependencies

template<class Time >

Dependencies dynamicgraph::TimeDependency< Time >::dependencies

Definition at line 31 of file time-dependency.h.

◆ DEPENDENCY_TYPE_DEFAULT

template<class Time >

const DependencyType dynamicgraph::TimeDependency< Time >::DEPENDENCY_TYPE_DEFAULT = TIME_DEPENDENT

static

Definition at line 29 of file time-dependency.h.

◆ dependencyType

template<class Time >

DependencyType dynamicgraph::TimeDependency< Time >::dependencyType

Definition at line 35 of file time-dependency.h.

◆ lastAskForUpdate

template<class Time >

Time dynamicgraph::TimeDependency< Time >::lastAskForUpdate

mutable

Definition at line 23 of file time-dependency.h.

◆ leader

template<class Time >

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

Definition at line 26 of file time-dependency.h.

◆ PERIOD_TIME_DEFAULT

template<class Time >

const Time dynamicgraph::TimeDependency< Time >::PERIOD_TIME_DEFAULT = 1

static

Definition at line 38 of file time-dependency.h.

◆ periodTime

template<class Time >

Time dynamicgraph::TimeDependency< Time >::periodTime

Definition at line 37 of file time-dependency.h.

◆ updateFromAllChildren

template<class Time >

bool dynamicgraph::TimeDependency< Time >::updateFromAllChildren

Definition at line 32 of file time-dependency.h.

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

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

Member Typedef Documentation

◆ Dependencies

Member Enumeration Documentation

◆ DependencyType

Constructor & Destructor Documentation

◆ TimeDependency() [1/2]

◆ TimeDependency() [2/2]

◆ ~TimeDependency()

Member Function Documentation

◆ addDependencies()

◆ addDependency()

◆ clearDependency()

◆ displayDependencies()

◆ getNeedUpdateFromAllChildren()

◆ getPeriodTime()

◆ needUpdate()

◆ removeDependency()

◆ setDependencyType()

◆ setNeedUpdateFromAllChildren()

◆ setPeriodTime()

◆ writeGraph()

Member Data Documentation

◆ ALL_READY_DEFAULT

◆ dependencies

◆ DEPENDENCY_TYPE_DEFAULT

◆ dependencyType

◆ lastAskForUpdate

◆ leader

◆ PERIOD_TIME_DEFAULT

◆ periodTime

◆ updateFromAllChildren

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