Glip::CorePipeline::AbstractComponentLayout Class Reference

Layout of a component template (Read Only) More...

#include <Component.hpp>

Inheritance diagram for Glip::CorePipeline::AbstractComponentLayout:

Public Member Functions
	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
	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 (Read Only)

Constructor & Destructor Documentation

AbstractComponentLayout::AbstractComponentLayout ( const std::string &  type )

protected

AbstractComponentLayout constructor.

Parameters

type	The layout name of the object.

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

protected

AbstractComponentLayout constructor.

Parameters

_layoutName	The layout name of the object.
_inputPorts	The list of the names of the input ports.
_outputPorts	The list of the names of the input ports.

AbstractComponentLayout::AbstractComponentLayout

(

const AbstractComponentLayout &

c

)

AbstractComponentLayout constructor.

Parameters

c

Copy.

Member Function Documentation

void AbstractComponentLayout::checkInputPort

(

int

i

)

const

Check the validity of an input port. Raise an exception if any errors occur.

Parameters

i	Index of the input port to test.

void AbstractComponentLayout::checkOutputPort

(

int

i

)

const

Check the validity of an output port. Raise an exception if any errors occur.

Parameters

i	Index of the output port to test.

bool AbstractComponentLayout::doesInputPortExist

(

const std::string &

name

)

const

Check if an input port exists, knowing its name.

Parameters

name	The name of the input port.

Returns

True if an input port named correctly exists, False otherwise.

bool AbstractComponentLayout::doesOutputPortExist

(

const std::string &

name

)

const

Check if an output port exists, knowing its name.

Parameters

name	The name of the output port.

Returns

True if an output port named correctly exists, False otherwise.

std::string AbstractComponentLayout::getFullName ( void  ) const

virtual

Returns the full name of this component (might be overloaded).

Returns

The full name of this component (possible name and layout name).

The full name of this component (name and layout name).

Reimplemented in Glip::CorePipeline::Component.

int AbstractComponentLayout::getInputPortID

(

const std::string &

name

)

const

Get the index of an input port knowing its name. Raise an exception if any errors occur.

Parameters

name	The name of the input port.

Returns

The index of the input port.

const std::string & AbstractComponentLayout::getInputPortName

(

int

id

)

const

Return the name of an input port. Raise an exception if any errors occur.

Parameters

id	The index of the input port.

Returns

The name of the input port as a standard string.

const std::string & AbstractComponentLayout::getLayoutName

(

void

)

const

Returns the layout name of this component.

Returns

The layout name of this component.

int AbstractComponentLayout::getNumInputPort

(

void

)

const

Get the number of input ports.

Returns

Number of input ports.

int AbstractComponentLayout::getNumOutputPort

(

void

)

const

Get the number of output ports.

Returns

Number of output ports.

int AbstractComponentLayout::getOutputPortID

(

const std::string &

name

)

const

Get the index of an output port knowing its name. Raise an exception if any errors occur.

Parameters

name	The name of the output port.

Returns

The index of the output port.

const std::string & AbstractComponentLayout::getOutputPortName

(

int

id

)

const

Return the name of an output port. Raise an exception if any errors occur.

Parameters

id	The index of the output port.

Returns

The name of the output port as a standard string.

---

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

• Component.hpp
• Component.cpp