wns::ldk::fun::Main Class Reference

FUN - Functional Unit Network. More...

#include <ldk/fun/Main.hpp>

Inheritance diagram for wns::ldk::fun::Main:

[legend]

Collaboration diagram for wns::ldk::fun::Main:

[legend]

List of all members.

Public Types
typedef std::map< std::string, FunctionalUnit * >	FunctionalUnitMap
Public Member Functions
virtual void	addFunctionalUnit (const std::string &name, FunctionalUnit *functionalUnit)
	Register a FU at the FUN with a given name.
virtual void	addFunctionalUnit (const std::string &commandName, const std::string &functionalUnitName, FunctionalUnit *functionalUnit)
	Register a FU at the FUN with a given fuName and distinct commandName.
virtual void	connectFunctionalUnit (const std::string &upperName, const std::string &lowerName, const std::string &srcPort="SinglePort", const std::string &dstPort="SinglePort")
	Connect two FUs in the outgoing and in the incoming flow.
virtual void	downConnectFunctionalUnit (const std::string &upperName, const std::string &lowerName, const std::string &srcPort="SinglePort", const std::string &dstPort="SinglePort")
	Connect two FUs in the outgoing flow.
virtual CommandReaderInterface *	getCommandReader (const std::string &commandName) const
virtual FunctionalUnit *	getFunctionalUnit (const std::string &name) const
	Replace a single FU by another FU using a PyConfigView for controling the reconfiguration process.
virtual ILayer *	getLayer () const
virtual LinkHandlerInterface *	getLinkHandler () const
virtual std::string	getName () const
virtual CommandProxy *	getProxy () const
virtual bool	knowsFunctionalUnit (const std::string &name) const
	Ask whether a FU with the given name is registered at the FUN.
	Main (ILayer *layer, const wns::pyconfig::View &_config)
	This is the new default constructor for a FUN.
	Main (ILayer *layer)
void	onFUNCreated (wns::logger::Logger *logger=NULL)
virtual void	removeFunctionalUnit (const std::string &name)
	Remove an FU with a given name from the FUN.
virtual void	upConnectFunctionalUnit (const std::string &upperName, const std::string &lowerName, const std::string &srcPort="SinglePort", const std::string &dstPort="SinglePort")
	Connect two FUs in the incoming flow.
virtual	~Main ()
Private Attributes
FunctionalUnitMap	fuMap
ILayer *	layer
LinkHandlerInterface *	linkHandler
wns::logger::Logger	logger
CommandProxy *	proxy

---

Detailed Description

See also:

How to implement a Layer

Definition at line 55 of file Main.hpp.

---

Member Typedef Documentation

typedef std::map<std::string, FunctionalUnit*> wns::ldk::fun::Main::FunctionalUnitMap

Reimplemented from wns::ldk::fun::FUN.

Definition at line 59 of file Main.hpp.

---

Constructor & Destructor Documentation

wns::ldk::fun::Main::Main

(

ILayer *

layer

)

Deprecated:

Don't use this constructor any more!

wns::ldk::fun::Main::Main	(	ILayer *	layer,
		const wns::pyconfig::View &	_config
	)

Todo:

: ksw,msg

• change all calls of the deprecated constructor to calls of the new one

virtual wns::ldk::fun::Main::~Main

(

)

[virtual]

---

Member Function Documentation

virtual void wns::ldk::fun::Main::addFunctionalUnit	(	const std::string &	name,
		FunctionalUnit *	functionalUnit
	)			[virtual]

Implements wns::ldk::fun::FUN.

virtual void wns::ldk::fun::Main::addFunctionalUnit	(	const std::string &	commandName,
		const std::string &	functionalUnitName,
		FunctionalUnit *	functionalUnit
	)			[virtual]

Implements wns::ldk::fun::FUN.

virtual void wns::ldk::fun::Main::connectFunctionalUnit	(	const std::string &	upperName,
		const std::string &	lowerName,
		const std::string &	srcPort = "SinglePort",
		const std::string &	dstPort = "SinglePort"
	)			[virtual]

Implements wns::ldk::fun::FUN.

virtual void wns::ldk::fun::Main::downConnectFunctionalUnit	(	const std::string &	upperName,
		const std::string &	lowerName,
		const std::string &	srcPort = "SinglePort",
		const std::string &	dstPort = "SinglePort"
	)			[virtual]

Implements wns::ldk::fun::FUN.

virtual CommandReaderInterface* wns::ldk::fun::Main::getCommandReader

(

const std::string &

commandName

)

const [virtual]

Implements wns::ldk::fun::FUN.

virtual FunctionalUnit* wns::ldk::fun::Main::getFunctionalUnit

(

const std::string &

name

)

const [virtual]

Return the FU registered at the FUN with the given name.

Implements wns::ldk::fun::FUN.

virtual ILayer* wns::ldk::fun::Main::getLayer

(

)

const [virtual]

Implements wns::ldk::fun::FUN.

virtual LinkHandlerInterface* wns::ldk::fun::Main::getLinkHandler

(

)

const [virtual]

Implements wns::ldk::fun::FUN.

virtual std::string wns::ldk::fun::Main::getName

(

)

const [virtual]

Implements wns::ldk::fun::FUN.

virtual CommandProxy* wns::ldk::fun::Main::getProxy

(

)

const [virtual]

Implements wns::ldk::fun::FUN.

virtual bool wns::ldk::fun::Main::knowsFunctionalUnit

(

const std::string &

name

)

const [virtual]

Implements wns::ldk::fun::FUN.

void wns::ldk::fun::Main::onFUNCreated

(

wns::logger::Logger *

logger = NULL

)

virtual void wns::ldk::fun::Main::removeFunctionalUnit

(

const std::string &

name

)

[virtual]

Implements wns::ldk::fun::FUN.

virtual void wns::ldk::fun::Main::upConnectFunctionalUnit	(	const std::string &	upperName,
		const std::string &	lowerName,
		const std::string &	srcPort = "SinglePort",
		const std::string &	dstPort = "SinglePort"
	)			[virtual]

Implements wns::ldk::fun::FUN.

---

Member Data Documentation

FunctionalUnitMap wns::ldk::fun::Main::fuMap [private]

Definition at line 120 of file Main.hpp.

ILayer* wns::ldk::fun::Main::layer [private]

Definition at line 118 of file Main.hpp.

LinkHandlerInterface* wns::ldk::fun::Main::linkHandler [private]

Definition at line 121 of file Main.hpp.

wns::logger::Logger wns::ldk::fun::Main::logger [private]

Definition at line 122 of file Main.hpp.

CommandProxy* wns::ldk::fun::Main::proxy [private]

Definition at line 119 of file Main.hpp.

---

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

• framework/library/src/ldk/fun/Main.hpp