wns::ldk::Group Class Reference
[Group]

Functional Unit holding a Sub FUN.

ldk::fun::Sub is a FUN that can be placed within another FUN. Group is a FU wrapping such a Sub FUN. More...

#include <ldk/Group.hpp>

Inheritance diagram for wns::ldk::Group:

[legend]

Collaboration diagram for wns::ldk::Group:

[legend]

List of all members.

Public Member Functions
fun::Sub *	getSubFUN () const
	Group (const Group &other)
	Group (fun::FUN *fuNet, const pyconfig::View &_config)
virtual void	onFUNCreated ()
	Resolve inter-FU dependencies.
virtual void	setName (std::string _name)
	Set the name of the FU.
	~Group ()
Private Member Functions
virtual bool	doIsAccepting (const CompoundPtr &compound) const
virtual void	doOnData (const CompoundPtr &compound)
virtual void	doSendData (const CompoundPtr &compound)
virtual void	doWakeup ()
Private Attributes
pyconfig::View	config
logger::Logger	logger
fun::Sub *	sub

---

Detailed Description

Group has two major use cases: 1. Logical Grouping 2. Interplay with FlowSeparator

Definition at line 64 of file Group.hpp.

---

Constructor & Destructor Documentation

Group::Group	(	fun::FUN *	fuNet,
		const pyconfig::View &	_config
	)

Definition at line 41 of file Group.cpp.

Group::~Group

(

)

Definition at line 210 of file Group.cpp.

Group::Group

(

const Group &

other

)

Definition at line 121 of file Group.cpp.

---

Member Function Documentation

bool Group::doIsAccepting

(

const CompoundPtr &

compound

)

const [private, virtual]

Definition at line 224 of file Group.cpp.

void Group::doOnData

(

const CompoundPtr &

compound

)

[private, virtual]

Definition at line 242 of file Group.cpp.

void Group::doSendData

(

const CompoundPtr &

compound

)

[private, virtual]

Definition at line 233 of file Group.cpp.

void Group::doWakeup

(

)

[private, virtual]

Definition at line 251 of file Group.cpp.

fun::Sub * Group::getSubFUN

(

)

const

Definition at line 260 of file Group.cpp.

void Group::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 217 of file Group.cpp.

void Group::setName

(

std::string

_name

)

[virtual]

Reimplemented from wns::ldk::FunctionalUnit.

Definition at line 267 of file Group.cpp.

---

Member Data Documentation

pyconfig::View wns::ldk::Group::config [private]

Definition at line 92 of file Group.hpp.

logger::Logger wns::ldk::Group::logger [private]

Definition at line 93 of file Group.hpp.

fun::Sub* wns::ldk::Group::sub [private]

Definition at line 95 of file Group.hpp.

---

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

• framework/library/src/ldk/Group.hpp
• framework/library/src/ldk/Group.cpp