wns::ldk::ShortcutFU< ADDRESS, ELEMENT > Class Template Reference

The ShortcutFU provides straight connection of corresponding ShortcutFUs in peer entities. The instances register themselves with their unique addresses available in the module the FU is being placed.

#include <ldk/ShortcutFU.hpp>

Inheritance diagram for wns::ldk::ShortcutFU< ADDRESS, ELEMENT >:

[legend]

Collaboration diagram for wns::ldk::ShortcutFU< ADDRESS, ELEMENT >:

[legend]

List of all members.

Public Types
typedef wns::container::Registry < ADDRESS, ELEMENT, wns::container::registry::NoneOnErase >	ContainerType
Public Member Functions
virtual bool	doIsAccepting (const wns::ldk::CompoundPtr &) const
virtual void	doOnData (const wns::ldk::CompoundPtr &_compound)
virtual void	doSendData (const wns::ldk::CompoundPtr &_compound)
virtual void	doWakeup ()
virtual ADDRESS	getDestinationAddress (const wns::ldk::CompoundPtr &)=0
	To whom should I send this compound?
virtual ADDRESS	getSourceAddress ()=0
	If you are a receiver, what is your address?
virtual bool	isBroadcast (const wns::ldk::CompoundPtr &)=0
	Shall I send this compound to every receiver?
virtual bool	isReceiver ()=0
	Only receivers will be considered when sending data. Tell me, are you a receiver?
virtual void	onFUNCreated ()
	Resolve inter-FU dependencies.
void	reset ()
void	sendCompoundsInQueue ()
	ShortcutFU (fun::FUN *_fun, const wns::pyconfig::View &_pyco)
virtual	~ShortcutFU ()
Protected Member Functions
ContainerType &	getElementRegistry ()
Protected Attributes
wns::logger::Logger	logger
Private Attributes
std::deque< wns::ldk::CompoundPtr >	compoundQueue
	FIFO queue for all compounds to be sent.
wns::distribution::Distribution *	delay
	The distribution for transmission delay.
simTimeType	offset
	Offset in [ms] to empty the compoundQueues.
wns::events::scheduler::Interface *	scheduler

---

Detailed Description

template<typename ADDRESS, typename ELEMENT>
class wns::ldk::ShortcutFU< ADDRESS, ELEMENT >

Definition at line 48 of file ShortcutFU.hpp.

---

Member Typedef Documentation

template<typename ADDRESS, typename ELEMENT>

typedef wns::container::Registry<ADDRESS, ELEMENT, wns::container::registry::NoneOnErase> wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::ContainerType

Definition at line 177 of file ShortcutFU.hpp.

---

Constructor & Destructor Documentation

template<typename ADDRESS, typename ELEMENT>

wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::ShortcutFU	(	fun::FUN *	_fun,
		const wns::pyconfig::View &	_pyco
	)			[inline]

Definition at line 51 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

virtual wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::~ShortcutFU

(

)

[inline, virtual]

Definition at line 67 of file ShortcutFU.hpp.

---

Member Function Documentation

template<typename ADDRESS, typename ELEMENT>

virtual bool wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::doIsAccepting

(

const wns::ldk::CompoundPtr &

)

const [inline, virtual]

Definition at line 80 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

virtual void wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::doOnData

(

const wns::ldk::CompoundPtr &

_compound

)

[inline, virtual]

Definition at line 95 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

virtual void wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::doSendData

(

const wns::ldk::CompoundPtr &

_compound

)

[inline, virtual]

Definition at line 87 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

virtual void wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::doWakeup

(

)

[inline, virtual]

Definition at line 83 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

virtual ADDRESS wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::getDestinationAddress

(

const wns::ldk::CompoundPtr &

)

[pure virtual]

Implemented in lte::controlplane::RRHandlerShortcutUT, lte::controlplane::RRHandlerShortcutBS, and lte::macr::RACHShortcut.

template<typename ADDRESS, typename ELEMENT>

ContainerType& wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::getElementRegistry

(

)

[inline, protected]

Definition at line 201 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

virtual ADDRESS wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::getSourceAddress

(

)

[pure virtual]

Implemented in lte::controlplane::RRHandlerShortcutUT, lte::controlplane::RRHandlerShortcutBS, and lte::macr::RACHShortcut.

template<typename ADDRESS, typename ELEMENT>

virtual bool wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::isBroadcast

(

const wns::ldk::CompoundPtr &

)

[pure virtual]

Implemented in lte::controlplane::RRHandlerShortcutUT, lte::controlplane::RRHandlerShortcutBS, and lte::macr::RACHShortcut.

template<typename ADDRESS, typename ELEMENT>

virtual bool wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::isReceiver

(

)

[pure virtual]

Implemented in lte::controlplane::RRHandlerShortcutUT, lte::controlplane::RRHandlerShortcutBS, lte::macr::RACHShortcutBS, and lte::macr::RACHShortcutUT.

template<typename ADDRESS, typename ELEMENT>

virtual void wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::onFUNCreated

(

)

[inline, 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.

Reimplemented in lte::controlplane::RRHandlerShortcut.

Definition at line 131 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

void wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::reset

(

)

[inline]

Definition at line 171 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

void wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::sendCompoundsInQueue

(

)

[inline]

Definition at line 142 of file ShortcutFU.hpp.

---

Member Data Documentation

template<typename ADDRESS, typename ELEMENT>

std::deque<wns::ldk::CompoundPtr> wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::compoundQueue [private]

Definition at line 195 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

wns::distribution::Distribution* wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::delay [private]

Definition at line 185 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

wns::logger::Logger wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::logger [protected]

Definition at line 198 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

simTimeType wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::offset [private]

Definition at line 190 of file ShortcutFU.hpp.

template<typename ADDRESS, typename ELEMENT>

wns::events::scheduler::Interface* wns::ldk::ShortcutFU< ADDRESS, ELEMENT >::scheduler [private]

Definition at line 180 of file ShortcutFU.hpp.

---

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

• framework/library/src/ldk/ShortcutFU.hpp