wimac::frame::TimingControl Class Reference

WiMAC specific Timing Control. More...

#include <frame/TimingControl.hpp>

Inheritance diagram for wimac::frame::TimingControl:

[legend]

Collaboration diagram for wimac::frame::TimingControl:

[legend]

List of all members.

Public Types
enum	Activation { Start, StartCollection, FinishCollection, Pause }
Public Member Functions
void	configure ()
	Configures the TimingControl.
void	finishedPhase (wns::ldk::fcf::CompoundCollectorInterface *collector)
	Inform the TimingControl about the end of the phase that is controlled by the collector.
wns::ldk::fcf::FrameBuilder *	getFrameBuilder () const
	Return the role for the questioned Phase.
int	getOffset ()
void	getRole ()
void	onFUNCreated ()
void	onTimeout ()
	Your callback. Implement this.
void	pause ()
	Pause the timingcontrol's operation.
void	periodically ()
	Your callback. Implement this!
void	start ()
	Starts the timingcontrol's operation.
void	stop ()
	Stops the timingcontrol's operation.
	TimingControl (wns::ldk::fcf::FrameBuilder *fb, const wns::pyconfig::View &config)
Private Types
typedef std::list < ActivationEntry >	Activations
Private Member Functions
void	processOneActivation ()
void	startProcessingActivations ()
Private Attributes
Activations	activations_
	Chronologically ordered list of activations.
Activations::const_iterator	activeCC_
	Indicates the active CompoundCollector.
wns::pyconfig::View	config_
wns::ldk::fcf::FrameBuilder *	frameBuilder_
wns::simulator::Time	frameStartTime_
wns::simulator::Time	frameStartupDelay_
bool	running_
Friends
class	TriggerActivationStart
Classes
struct	ActivationEntry

---

Detailed Description

The Timing Control of the WiMAC module introduces abstract Activations to the Frame Configuration Framework. Each CompoundCollector is activated by three different types of Activations (Start, StartCollection, FinishCollection). The Activations specify the concrete action the CompoundCollector has to perform. The chronologically ordered list of Activations is created from (/defined by) the PyConig file.

Definition at line 59 of file TimingControl.hpp.

---

Member Typedef Documentation

typedef std::list<ActivationEntry> wimac::frame::TimingControl::Activations [private]

Definition at line 102 of file TimingControl.hpp.

---

Member Enumeration Documentation

enum wimac::frame::TimingControl::Activation

Enumerator:

Start
StartCollection
FinishCollection
Pause

Definition at line 66 of file TimingControl.hpp.

---

Constructor & Destructor Documentation

TimingControl::TimingControl	(	wns::ldk::fcf::FrameBuilder *	fb,
		const wns::pyconfig::View &	config
	)

Definition at line 70 of file TimingControl.cpp.

---

Member Function Documentation

void TimingControl::configure

(

)

[virtual]

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

Definition at line 116 of file TimingControl.cpp.

void TimingControl::finishedPhase

(

wns::ldk::fcf::CompoundCollectorInterface *

collector

)

[virtual]

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

Definition at line 197 of file TimingControl.cpp.

wns::ldk::fcf::FrameBuilder* wimac::frame::TimingControl::getFrameBuilder

(

)

const [inline, virtual]

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

Definition at line 81 of file TimingControl.hpp.

int TimingControl::getOffset

(

)

Definition at line 334 of file TimingControl.cpp.

void wimac::frame::TimingControl::getRole

(

)

void TimingControl::onFUNCreated

(

)

Definition at line 121 of file TimingControl.cpp.

void TimingControl::onTimeout

(

)

[virtual]

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

Implements wns::events::CanTimeout.

Definition at line 261 of file TimingControl.cpp.

void TimingControl::pause

(

)

[virtual]

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

Definition at line 101 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 227 of file TimingControl.cpp.

void TimingControl::processOneActivation

(

)

[private]

Definition at line 283 of file TimingControl.cpp.

void TimingControl::start

(

)

[virtual]

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

Definition at line 89 of file TimingControl.cpp.

void TimingControl::startProcessingActivations

(

)

[private]

Definition at line 245 of file TimingControl.cpp.

void TimingControl::stop

(

)

[virtual]

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

Definition at line 107 of file TimingControl.cpp.

---

Friends And Related Function Documentation

friend class TriggerActivationStart [friend]

Definition at line 133 of file TimingControl.hpp.

---

Member Data Documentation

Activations wimac::frame::TimingControl::activations_ [private]

For the modes sending and receiving a CompoundCollector has three Activations: startCollection, finishCollection, start For the mode pause only one activation is valid: pause

Definition at line 115 of file TimingControl.hpp.

Activations::const_iterator wimac::frame::TimingControl::activeCC_ [private]

Definition at line 120 of file TimingControl.hpp.

wns::pyconfig::View wimac::frame::TimingControl::config_ [private]

Definition at line 128 of file TimingControl.hpp.

wns::ldk::fcf::FrameBuilder* wimac::frame::TimingControl::frameBuilder_ [private]

Definition at line 125 of file TimingControl.hpp.

wns::simulator::Time wimac::frame::TimingControl::frameStartTime_ [private]

Definition at line 131 of file TimingControl.hpp.

wns::simulator::Time wimac::frame::TimingControl::frameStartupDelay_ [private]

Definition at line 130 of file TimingControl.hpp.

bool wimac::frame::TimingControl::running_ [private]

Definition at line 127 of file TimingControl.hpp.

---

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

• modules/dll/wimac/src/frame/TimingControl.hpp
• modules/dll/wimac/src/frame/TimingControl.cpp