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 >:

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	addDependencies (const SignalArray_const< Time > &arr)
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

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

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

References dynamicgraph::TimeDependency< Time >::addDependencies().

template<class Time>

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

inlinevirtual

Member Function Documentation

template<class Time>

void dynamicgraph::TimeDependency< Time >::addDependencies

(

const SignalArray_const< Time > &

arr

)

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

Referenced by dynamicgraph::TimeDependency< Time >::TimeDependency(), and dynamicgraph::TimeDependency< int >::~TimeDependency().

template<class Time>

void dynamicgraph::TimeDependency< Time >::addDependency

(

const SignalBase< Time > &

sig

)

References dynamicgraph::TimeDependency< Time >::dependencies.

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

template<class Time >

void dynamicgraph::TimeDependency< Time >::clearDependency

(

)

References dynamicgraph::TimeDependency< Time >::dependencies.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::clearDependencies(), and dynamicgraph::TimeDependency< int >::~TimeDependency().

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 dynamicgraph::TimeDependency< Time >::ALWAYS_READY, dynamicgraph::TimeDependency< Time >::BOOL_DEPENDENT, dynamicgraph::TimeDependency< Time >::dependencies, dynamicgraph::TimeDependency< Time >::dependencyType, dynamicgraph::TimeDependency< Time >::leader, dynamicgraph::TimeDependency< Time >::periodTime, and dynamicgraph::TimeDependency< Time >::TIME_DEPENDENT.

Referenced by dynamicgraph::SignalTimeDependent< int, int >::displayDependencies(), and dynamicgraph::TimeDependency< int >::~TimeDependency().

template<class Time>

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

inline

template<class Time>

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

inline

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

template<class Time>

bool dynamicgraph::TimeDependency< Time >::needUpdate

(

const Time &

t1

)

const

References dynamicgraph::TimeDependency< Time >::ALWAYS_READY, dynamicgraph::TimeDependency< Time >::BOOL_DEPENDENT, dynamicgraph::TimeDependency< Time >::dependencies, dynamicgraph::TimeDependency< Time >::dependencyType, dgTDEBUG, dgTDEBUGOUT, dynamicgraph::SignalBase< Time >::getTime(), dynamicgraph::TimeDependency< Time >::lastAskForUpdate, dynamicgraph::TimeDependency< Time >::leader, dynamicgraph::SignalBase< Time >::needUpdate(), dynamicgraph::TimeDependency< Time >::periodTime, dynamicgraph::TimeDependency< Time >::TIME_DEPENDENT, and dynamicgraph::TimeDependency< Time >::updateFromAllChildren.

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

template<class Time>

void dynamicgraph::TimeDependency< Time >::removeDependency

(

const SignalBase< Time > &

sig

)

References dynamicgraph::TimeDependency< Time >::dependencies.

Referenced by dynamicgraph::SignalTimeDependent< T, Time >::removeDependency(), and dynamicgraph::TimeDependency< int >::~TimeDependency().

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

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

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 dynamicgraph::TimeDependency< Time >::dependencies, and dynamicgraph::TimeDependency< Time >::leader.

Referenced by dynamicgraph::TimeDependency< int >::~TimeDependency().

Member Data Documentation

template<class Time>

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

static

template<class Time>

Dependencies dynamicgraph::TimeDependency< Time >::dependencies

Referenced by dynamicgraph::TimeDependency< Time >::addDependency(), dynamicgraph::TimeDependency< Time >::clearDependency(), dynamicgraph::TimeDependency< Time >::displayDependencies(), dynamicgraph::TimeDependency< Time >::needUpdate(), dynamicgraph::TimeDependency< Time >::removeDependency(), and dynamicgraph::TimeDependency< Time >::writeGraph().

template<class Time>

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

static

template<class Time>

DependencyType dynamicgraph::TimeDependency< Time >::dependencyType

Referenced by dynamicgraph::TimeDependency< Time >::displayDependencies(), and dynamicgraph::TimeDependency< Time >::needUpdate().

template<class Time>

Time dynamicgraph::TimeDependency< Time >::lastAskForUpdate

mutable

Referenced by dynamicgraph::TimeDependency< Time >::needUpdate().

template<class Time>

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

Referenced by dynamicgraph::TimeDependency< Time >::displayDependencies(), dynamicgraph::TimeDependency< Time >::needUpdate(), and dynamicgraph::TimeDependency< Time >::writeGraph().

template<class Time>

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

static

template<class Time>

Time dynamicgraph::TimeDependency< Time >::periodTime

Referenced by dynamicgraph::TimeDependency< Time >::displayDependencies(), dynamicgraph::TimeDependency< int >::getPeriodTime(), and dynamicgraph::TimeDependency< Time >::needUpdate().

template<class Time>

bool dynamicgraph::TimeDependency< Time >::updateFromAllChildren

Referenced by dynamicgraph::TimeDependency< int >::getNeedUpdateFromAllChildren(), and dynamicgraph::TimeDependency< Time >::needUpdate().