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

The FrameBuilderPutter forwards incoming packets to the FrameBuilder. More...

#include <ldk/fcf/FrameBuilderPutter.hpp>

Inheritance diagram for wns::ldk::fcf::FrameBuilderPutter:

[legend]

Collaboration diagram for wns::ldk::fcf::FrameBuilderPutter:

[legend]

List of all members.

Public Member Functions
void	doOnData (const wns::ldk::CompoundPtr &)
void	doSendData (const wns::ldk::CompoundPtr &)
	FrameBuilderPutter (wns::ldk::fun::FUN *, const wns::pyconfig::View &)
void	onFUNCreated ()
	Resolve inter-FU dependencies.
Private Member Functions
bool	doIsAccepting (const wns::ldk::CompoundPtr &) const
void	doWakeup ()
Private Attributes
std::string	frameBuilderName
struct {
wns::ldk::FunctionalUnit *   destination
}	friends

---

Detailed Description

The FrameBuilderPutter is a helper class for the FrameBuilder. The FrameBuilder does only accept pairs of functional unit connections. The FrameBuilderPutter indicates compounds directly to the FrameBuilder.

Todo:

This class has not a real function. It is a workaround.

Definition at line 55 of file FrameBuilderPutter.hpp.

---

Constructor & Destructor Documentation

FrameBuilderPutter::FrameBuilderPutter	(	wns::ldk::fun::FUN *	_fun,
		const wns::pyconfig::View &	_config
	)

Definition at line 37 of file FrameBuilderPutter.cpp.

---

Member Function Documentation

bool FrameBuilderPutter::doIsAccepting

(

const wns::ldk::CompoundPtr &

)

const [private]

Definition at line 43 of file FrameBuilderPutter.cpp.

void FrameBuilderPutter::doOnData

(

const wns::ldk::CompoundPtr &

_compound

)

Definition at line 54 of file FrameBuilderPutter.cpp.

void FrameBuilderPutter::doSendData

(

const wns::ldk::CompoundPtr &

)

Definition at line 49 of file FrameBuilderPutter.cpp.

void wns::ldk::fcf::FrameBuilderPutter::doWakeup

(

)

[inline, private]

Definition at line 71 of file FrameBuilderPutter.hpp.

void FrameBuilderPutter::onFUNCreated

(

)

[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 59 of file FrameBuilderPutter.cpp.

---

Member Data Documentation

wns::ldk::FunctionalUnit* wns::ldk::fcf::FrameBuilderPutter::destination

Definition at line 76 of file FrameBuilderPutter.hpp.

std::string wns::ldk::fcf::FrameBuilderPutter::frameBuilderName [private]

Definition at line 74 of file FrameBuilderPutter.hpp.

struct { ... } wns::ldk::fcf::FrameBuilderPutter::friends [private]

---

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

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