wimemac::frame::BeaconCollector Class Reference

#include <frame/BeaconCollector.hpp>

Inheritance diagram for wimemac::frame::BeaconCollector:

[legend]

Collaboration diagram for wimemac::frame::BeaconCollector:

[legend]

List of all members.

Public Member Functions
	BeaconCollector (wns::ldk::fun::FUN *fun, const wns::pyconfig::View &config)
bool	doIsAccepting (const wns::ldk::CompoundPtr &compound) const
void	doOnData (const wns::ldk::CompoundPtr &)
void	doSendData (const wns::ldk::CompoundPtr &)
void	doStart (int)
void	doStartCollection (int)
void	doWakeup ()
void	finishCollection ()
	Triggers the CompoundCollector to resolve horiziontal dependencies.
wns::simulator::Time	getCurrentDuration () const
	Returns the duration of all collected compounds so far.
void	TimeToTransmit ()
Protected Member Functions
virtual void	onFUNCreated ()
	Resolve inter-FU dependencies.
Private Member Functions
void	onTimeout ()
	Your callback. Implement this.
Private Attributes
int	BeaconSlot
wns::simulator::Time	BeaconSlotDuration
wns::simulator::Time	BPStart
wns::simulator::Time	duration
struct wimemac::frame::BeaconCollector::Friends	friends
bool	gotWakeup
wns::logger::Logger	logger
const std::string	managerName
bool	sending
Classes
struct	Friends

---

Detailed Description

Definition at line 58 of file BeaconCollector.hpp.

---

Constructor & Destructor Documentation

BeaconCollector::BeaconCollector	(	wns::ldk::fun::FUN *	fun,
		const wns::pyconfig::View &	config
	)

Definition at line 39 of file BeaconCollector.cpp.

---

Member Function Documentation

bool BeaconCollector::doIsAccepting

(

const wns::ldk::CompoundPtr &

compound

)

const

Definition at line 63 of file BeaconCollector.cpp.

void BeaconCollector::doOnData

(

const wns::ldk::CompoundPtr &

compound

)

Definition at line 56 of file BeaconCollector.cpp.

void BeaconCollector::doSendData

(

const wns::ldk::CompoundPtr &

compound

)

Definition at line 70 of file BeaconCollector.cpp.

void BeaconCollector::doStart

(

int

mode

)

[virtual]

Implements wns::ldk::fcf::CompoundCollector.

Definition at line 86 of file BeaconCollector.cpp.

void wimemac::frame::BeaconCollector::doStartCollection

(

int

)

[inline, virtual]

Implements wns::ldk::fcf::CompoundCollector.

Definition at line 80 of file BeaconCollector.hpp.

void BeaconCollector::doWakeup

(

)

[virtual]

Reimplemented from wns::ldk::fcf::CompoundCollector.

Definition at line 139 of file BeaconCollector.cpp.

void wimemac::frame::BeaconCollector::finishCollection

(

)

[inline, virtual]

Implements wns::ldk::fcf::CompoundCollectorInterface.

Definition at line 81 of file BeaconCollector.hpp.

wns::simulator::Time wimemac::frame::BeaconCollector::getCurrentDuration

(

)

const [inline, virtual]

Sometimes CompoundCollectors need to know how much time is still free for their phase. The FrameBuilder asks all CompoundCollectors how much time is already used by the CompoundCollectors. The minimum duration is the duration hint of the PhaseDescriptor.

Implements wns::ldk::fcf::CompoundCollectorInterface.

Definition at line 86 of file BeaconCollector.hpp.

void BeaconCollector::onFUNCreated

(

)

[protected, virtual]

Often FunctionalUnits require the collaboration with other FunctionalUnits to accomplish their task. For the collaboration between FunctionalUnits we coined the term "friendship".

The onFUNCreated method is a hook being called after the complete FUN has been set up. FunctionalUnits requiring the collaboration with other FunctionalUnits should resolve these dependencies by implementing this hook accordingly.

Finding friends is usually done calling wns::ldk::fun::FUN::findFriend.

When building reconfigurable FUNs, this method may get called multiple times (e.g., after each FUN reconfiguration). Keep that in mind when allocating resources in your onFUNCreated implementation.

Reimplemented from wns::ldk::FunctionalUnit.

Definition at line 123 of file BeaconCollector.cpp.

void BeaconCollector::onTimeout

(

)

[private, virtual]

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

Implements wns::events::CanTimeout.

Definition at line 109 of file BeaconCollector.cpp.

void BeaconCollector::TimeToTransmit

(

)

Definition at line 149 of file BeaconCollector.cpp.

---

Member Data Documentation

int wimemac::frame::BeaconCollector::BeaconSlot [private]

Definition at line 100 of file BeaconCollector.hpp.

wns::simulator::Time wimemac::frame::BeaconCollector::BeaconSlotDuration [private]

Definition at line 96 of file BeaconCollector.hpp.

wns::simulator::Time wimemac::frame::BeaconCollector::BPStart [private]

Definition at line 101 of file BeaconCollector.hpp.

wns::simulator::Time wimemac::frame::BeaconCollector::duration [private]

Definition at line 95 of file BeaconCollector.hpp.

struct wimemac::frame::BeaconCollector::Friends wimemac::frame::BeaconCollector::friends [private]

bool wimemac::frame::BeaconCollector::gotWakeup [private]

Definition at line 98 of file BeaconCollector.hpp.

wns::logger::Logger wimemac::frame::BeaconCollector::logger [private]

Definition at line 94 of file BeaconCollector.hpp.

const std::string wimemac::frame::BeaconCollector::managerName [private]

Definition at line 107 of file BeaconCollector.hpp.

bool wimemac::frame::BeaconCollector::sending [private]

Definition at line 99 of file BeaconCollector.hpp.

---

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

• modules/dll/wimemac/src/frame/BeaconCollector.hpp
• modules/dll/wimemac/src/frame/BeaconCollector.cpp