Layout of a component template. More...

#include <Component.hpp>

Inheritance diagram for Glip::CorePipeline::ComponentLayout:

Public Member Functions
	ComponentLayout (const std::string &_layoutName)
	ComponentLayout constructor. More...

	ComponentLayout (const AbstractComponentLayout &)
	ComponentLayout constructor. More...

void	setInputPortName (int i, const std::string &newName)
	Change the name of an input port. More...

void	setOutputPortName (int i, const std::string &newName)
	Change the name of an output port. More...

Public Member Functions inherited from Glip::CorePipeline::AbstractComponentLayout
	AbstractComponentLayout (const AbstractComponentLayout &)
	AbstractComponentLayout constructor. More...

void	checkInputPort (int i) const
	Check the validity of an input port. Raise an exception if any errors occur. More...

void	checkOutputPort (int i) const
	Check the validity of an output port. Raise an exception if any errors occur. More...

virtual std::string	getFullName (void) const
	Returns the full name of this component (might be overloaded). More...

const std::string &	getLayoutName (void) const
	Returns the layout name of this component. More...

int	getNumInputPort (void) const
	Get the number of input ports. More...

const std::string &	getInputPortName (int i) const
	Return the name of an input port. Raise an exception if any errors occur. More...

int	getInputPortID (const std::string &name) const
	Get the index of an input port knowing its name. Raise an exception if any errors occur. More...

bool	doesInputPortExist (const std::string &name) const
	Check if an input port exists, knowing its name. More...

int	getNumOutputPort (void) const
	Get the number of output ports. More...

const std::string &	getOutputPortName (int i) const
	Return the name of an output port. Raise an exception if any errors occur. More...

int	getOutputPortID (const std::string &name) const
	Get the index of an output port knowing its name. Raise an exception if any errors occur. More...

bool	doesOutputPortExist (const std::string &name) const
	Check if an output port exists, knowing its name. More...

Protected Member Functions
int	addOutputPort (const std::string &name)
	Add an output port. More...

int	addInputPort (const std::string &name)
	Add an input port. More...

Protected Member Functions inherited from Glip::CorePipeline::AbstractComponentLayout
	AbstractComponentLayout (const std::string &_layoutName)
	AbstractComponentLayout constructor. More...

	AbstractComponentLayout (const std::string &_layoutName, const std::vector< std::string > &_inputPorts, const std::vector< std::string > &_outputPorts)
	AbstractComponentLayout constructor. More...

Detailed Description

Layout of a component template.

Constructor & Destructor Documentation

ComponentLayout::ComponentLayout ( const std::string & _layoutName )

ComponentLayout constructor.

Parameters

_layoutName Layout name of the component.

ComponentLayout::ComponentLayout ( const AbstractComponentLayout & c )

ComponentLayout constructor.

Parameters

c Copy.

Member Function Documentation

int ComponentLayout::addInputPort ( const std::string & name )

protected

Add an input port.

Parameters

name	The name of the new input port.

Returns: The ID of the new input port.

int ComponentLayout::addOutputPort ( const std::string & name )

protected

Add an output port.

Parameters

name	The name of the new output port.

Returns: The ID of the new output port.

void ComponentLayout::setInputPortName	(	int	i,
		const std::string &	newName
	)

Change the name of an input port.

Parameters

i	The ID of the target input port.
newName	The name of the new input port.

void ComponentLayout::setOutputPortName	(	int	i,
		const std::string &	newName
	)

Change the name of an output port.

Parameters

i	The ID of the target output port.
newName	The name of the new output port.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation