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

Description of frame phases. More...

#include <ldk/fcf/PhaseDescriptor.hpp>

Inheritance diagram for wns::ldk::fcf::PhaseDescriptor:

[legend]

Collaboration diagram for wns::ldk::fcf::PhaseDescriptor:

[legend]

List of all members.

Public Member Functions
CompoundCollectorInterface *	getCompoundCollector () const
	Do further configuration.
FrameBuilder *	getFrameBuilder () const
std::string	getName () const
	Returns the name of this PhaseDescriptor.
void	onFUNCreated ()
	Trigger the PhaseDescriptor to find its friends.
bool	operator== (const PhaseDescriptor &rhs) const
	PhaseDescriptor (FrameBuilder *frameBuilder, const wns::pyconfig::View &config)
void	setName (const std::string &name)
Protected Attributes
CompoundCollectorInterface *	compoundCollector_
wns::pyconfig::View	config_
FrameBuilder *	frameBuilder_
std::string	name_
Friends
class	FrameBuilder

---

Detailed Description

The PhaseDescriptor is the configuration element of the FrameBuilder. Available configuration settings are

• the name of the phase
• the duration policy (fixed, expanding)

Definition at line 99 of file PhaseDescriptor.hpp.

---

Constructor & Destructor Documentation

PhaseDescriptor::PhaseDescriptor	(	FrameBuilder *	frameBuilder,
		const wns::pyconfig::View &	config
	)

Definition at line 46 of file PhaseDescriptor.cpp.

---

Member Function Documentation

CompoundCollectorInterface* wns::ldk::fcf::PhaseDescriptor::getCompoundCollector

(

)

const [inline, virtual]

Get the FunctionalUnit that handles the compounds of this phase.

Implements wns::ldk::fcf::PhaseDescriptorInterface.

Definition at line 122 of file PhaseDescriptor.hpp.

FrameBuilder* wns::ldk::fcf::PhaseDescriptor::getFrameBuilder

(

)

const [inline]

Definition at line 116 of file PhaseDescriptor.hpp.

std::string wns::ldk::fcf::PhaseDescriptor::getName

(

)

const [inline, virtual]

Implements wns::ldk::fcf::PhaseDescriptorInterface.

Definition at line 107 of file PhaseDescriptor.hpp.

void PhaseDescriptor::onFUNCreated

(

)

[virtual]

Implements wns::ldk::fcf::PhaseDescriptorInterface.

Definition at line 51 of file PhaseDescriptor.cpp.

bool wns::ldk::fcf::PhaseDescriptor::operator==

(

const PhaseDescriptor &

rhs

)

const [inline]

Definition at line 111 of file PhaseDescriptor.hpp.

void wns::ldk::fcf::PhaseDescriptor::setName

(

const std::string &

name

)

[inline]

Definition at line 128 of file PhaseDescriptor.hpp.

---

Friends And Related Function Documentation

friend class FrameBuilder [friend]

Definition at line 136 of file PhaseDescriptor.hpp.

---

Member Data Documentation

CompoundCollectorInterface* wns::ldk::fcf::PhaseDescriptor::compoundCollector_ [protected]

Definition at line 134 of file PhaseDescriptor.hpp.

wns::pyconfig::View wns::ldk::fcf::PhaseDescriptor::config_ [protected]

Definition at line 133 of file PhaseDescriptor.hpp.

FrameBuilder* wns::ldk::fcf::PhaseDescriptor::frameBuilder_ [protected]

Definition at line 132 of file PhaseDescriptor.hpp.

std::string wns::ldk::fcf::PhaseDescriptor::name_ [protected]

Definition at line 131 of file PhaseDescriptor.hpp.

---

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

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