wns::ldk::fcf::TimingControl Class Reference
[Frame Configuration]

Control entity of the TimingNodes. More...

#include <ldk/fcf/TimingControl.hpp>

Inheritance diagram for wns::ldk::fcf::TimingControl:

[legend]

Collaboration diagram for wns::ldk::fcf::TimingControl:

[legend]

List of all members.

Public Types
typedef std::list < CompoundCollectorInterface * >	CompoundCollectors
Public Member Functions
virtual void	configure ()
	Configures the TimingControl.
virtual void	finishedPhase (CompoundCollectorInterface *)
	Inform the TimingControl about the end of the phase that is controlled by the collector.
virtual FrameBuilder *	getFrameBuilder () const
	Return the role for the questioned Phase.
virtual int	getRole (PhaseDescriptorPtr p)
virtual void	nextPhase ()
void	onFUNCreated ()
virtual void	pause ()
	Pause the timingcontrol's operation.
void	periodically ()
	Your callback. Implement this!
virtual void	start ()
	Starts the timingcontrol's operation.
virtual void	stop ()
	Stops the timingcontrol's operation.
	TimingControl (FrameBuilder *frameBuilder, const pyconfig::View &config)
Private Attributes
CompoundCollectors::iterator	activeCC
CompoundCollectors	compoundCollectors
FrameBuilder *	frameBuilder
wns::logger::Logger	logger
bool	running

---

Detailed Description

The TimingControl manages the set of TimingNodes for all frame phases. TimingNodes inform the TimingControl whenever the phase has finished. The timing control calls the next timing node to start its phase.

Definition at line 97 of file TimingControl.hpp.

---

Member Typedef Documentation

typedef std::list<CompoundCollectorInterface*> wns::ldk::fcf::TimingControl::CompoundCollectors

Definition at line 102 of file TimingControl.hpp.

---

Constructor & Destructor Documentation

TimingControl::TimingControl	(	FrameBuilder *	frameBuilder,
		const pyconfig::View &	config
	)

Definition at line 46 of file TimingControl.cpp.

---

Member Function Documentation

void TimingControl::configure

(

)

[virtual]

Implements wns::ldk::fcf::TimingControlInterface.

Definition at line 84 of file TimingControl.cpp.

virtual void wns::ldk::fcf::TimingControl::finishedPhase

(

CompoundCollectorInterface *

collector

)

[inline, virtual]

Implements wns::ldk::fcf::TimingControlInterface.

Definition at line 122 of file TimingControl.hpp.

virtual FrameBuilder* wns::ldk::fcf::TimingControl::getFrameBuilder

(

)

const [inline, virtual]

Implements wns::ldk::fcf::TimingControlInterface.

Definition at line 127 of file TimingControl.hpp.

int TimingControl::getRole

(

PhaseDescriptorPtr

p

)

[virtual]

Definition at line 79 of file TimingControl.cpp.

void TimingControl::nextPhase

(

)

[virtual]

Definition at line 108 of file TimingControl.cpp.

void TimingControl::onFUNCreated

(

)

Definition at line 89 of file TimingControl.cpp.

void TimingControl::pause

(

)

[virtual]

Implements wns::ldk::fcf::TimingControlInterface.

Definition at line 65 of file TimingControl.cpp.

void TimingControl::periodically

(

)

[virtual]

The deriver is forced to implement this method. It gets called periodically, whenever the timer fires.

Implements wns::events::PeriodicTimeout.

Definition at line 133 of file TimingControl.cpp.

void TimingControl::start

(

)

[virtual]

Implements wns::ldk::fcf::TimingControlInterface.

Definition at line 55 of file TimingControl.cpp.

void TimingControl::stop

(

)

[virtual]

Implements wns::ldk::fcf::TimingControlInterface.

Definition at line 71 of file TimingControl.cpp.

---

Member Data Documentation

CompoundCollectors::iterator wns::ldk::fcf::TimingControl::activeCC [private]

Definition at line 135 of file TimingControl.hpp.

CompoundCollectors wns::ldk::fcf::TimingControl::compoundCollectors [private]

Definition at line 134 of file TimingControl.hpp.

FrameBuilder* wns::ldk::fcf::TimingControl::frameBuilder [private]

Definition at line 136 of file TimingControl.hpp.

wns::logger::Logger wns::ldk::fcf::TimingControl::logger [private]

Definition at line 137 of file TimingControl.hpp.

bool wns::ldk::fcf::TimingControl::running [private]

Definition at line 138 of file TimingControl.hpp.

---

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

• framework/library/src/ldk/fcf/TimingControl.hpp
• framework/library/src/ldk/fcf/TimingControl.cpp