wimemac::frame::DataCollector Class Reference

#include <frame/DataCollector.hpp>

Inheritance diagram for wimemac::frame::DataCollector:

[legend]

Collaboration diagram for wimemac::frame::DataCollector:

[legend]

List of all members.

Public Member Functions
	DataCollector (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.
Protected Member Functions
virtual void	onFUNCreated ()
	Resolve inter-FU dependencies.
Private Member Functions
void	onTimeout ()
	Your callback. Implement this.
Private Attributes
wns::pyconfig::View	_config
wns::simulator::Time	duration
wns::logger::Logger	logger
bool	sending

---

Detailed Description

Definition at line 52 of file DataCollector.hpp.

---

Constructor & Destructor Documentation

wimemac::frame::DataCollector::DataCollector	(	wns::ldk::fun::FUN *	fun,
		const wns::pyconfig::View &	config
	)

---

Member Function Documentation

bool wimemac::frame::DataCollector::doIsAccepting

(

const wns::ldk::CompoundPtr &

compound

)

const

void wimemac::frame::DataCollector::doOnData

(

const wns::ldk::CompoundPtr &

)

void wimemac::frame::DataCollector::doSendData

(

const wns::ldk::CompoundPtr &

)

void wimemac::frame::DataCollector::doStart

(

int

)

[virtual]

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

void wimemac::frame::DataCollector::doStartCollection

(

int

)

[inline, virtual]

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

Definition at line 77 of file DataCollector.hpp.

void wimemac::frame::DataCollector::doWakeup

(

)

[virtual]

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

void wimemac::frame::DataCollector::finishCollection

(

)

[inline, virtual]

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

Definition at line 78 of file DataCollector.hpp.

wns::simulator::Time wimemac::frame::DataCollector::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 80 of file DataCollector.hpp.

virtual void wimemac::frame::DataCollector::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.

void wimemac::frame::DataCollector::onTimeout

(

)

[private, virtual]

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

Implements wns::events::CanTimeout.

---

Member Data Documentation

wns::pyconfig::View wimemac::frame::DataCollector::_config [private]

Definition at line 92 of file DataCollector.hpp.

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

Definition at line 89 of file DataCollector.hpp.

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

Definition at line 88 of file DataCollector.hpp.

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

Definition at line 91 of file DataCollector.hpp.

---

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

• modules/dll/wimemac/src/frame/DataCollector.hpp