Element of a pipeline. More...

#include <Component.hpp>

Inheritance diagram for Glip::CorePipeline::Component:

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

const std::string &	getName (void) const
	Returns the name of this component. 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...

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
	Component (const std::string &_layoutName, const std::vector< std::string > &_inputPorts, const std::vector< std::string > &_outputPorts, const std::string &_instanceName)
	Component constructor. More...

	Component (const AbstractComponentLayout &, const std::string &_instanceName)
	Component constructor. 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

Element of a pipeline.

Constructor & Destructor Documentation

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

protected

Component 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.
_instanceName	The name of the component.

Component::Component	(	const AbstractComponentLayout &	c,
		const std::string &	_instanceName
	)

protected

Component constructor.

Parameters

c	The component layout.
_instanceName	The name of the component.

Member Function Documentation

std::string Component::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 from Glip::CorePipeline::AbstractComponentLayout.

const std::string & Component::getName ( void ) const

Returns the name of this component.

Returns: The name of this component.

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