Alida::ALDOperator Class Reference

Core class of the operator concept defining Alida operators. More...

#include <ALDOperator.h>

Inheritance diagram for Alida::ALDOperator:

Collaboration diagram for Alida::ALDOperator:

List of all members.

Public Member Functions
void	runOp () throw (ALDException)
	Method defining the entry point for operator execution.
void	validate () throw (ALDException)
	Validates the parameters of this operator.
virtual void	validateCustom ()
	Operator specific validation of parameters which should be overridden.
std::map< std::string, ALDOpParameterDescriptor * > &	getParameters ()
	Function returning list of registered parameters.
void *	getParameter (std::string)
	Returns the value of the specified parameter.
void	setParameter (std::string, void *)
	Sets the specified parameter to the given value.
Protected Member Functions
virtual	~ALDOperator ()
	Default destructor.
virtual void	operate ()=0
	Method to implement operator functionality.
Protected Attributes
std::map< std::string, ALDOpParameterDescriptor * >	parameters
	Map containing list of registered parameters.

---

Detailed Description

Core class of the operator concept defining Alida operators.

Definition at line 56 of file ALDOperator.h.

---

Constructor & Destructor Documentation

virtual Alida::ALDOperator::~ALDOperator

(

)

[inline, protected, virtual]

Default destructor.

Definition at line 64 of file ALDOperator.h.

---

Member Function Documentation

void * ALDOperator::getParameter

(

std::string

name

)

Returns the value of the specified parameter.

Parameters:

name	Name of the parameter the value is requested for.

Returns:

Pointer to the corresponding parameter value.

Definition at line 100 of file ALDOperator.cc.

Referenced by main(), Thres::operate(), DemoOperatorOpenCV::operate(), and Canny::operate().

std::map< std::string, ALDOpParameterDescriptor * > & ALDOperator::getParameters

(

)

Function returning list of registered parameters.

Returns:

Reference to the map of registered parameters.

Definition at line 91 of file ALDOperator.cc.

Referenced by main().

virtual void Alida::ALDOperator::operate

(

)

[protected, pure virtual]

Method to implement operator functionality.

Implemented in Canny, DemoOperator, DemoOperatorOpenCV, and Thres.

void ALDOperator::runOp

(

)

throw (ALDException)

Method defining the entry point for operator execution.

This functions is the only entry point for executing operators in Alida
It basically calls an operator's operate() function.
An Exception is thrown if either validation fails. In addition, automatic process documentation will be done here in the future.

Definition at line 56 of file ALDOperator.cc.

Referenced by main().

void ALDOperator::setParameter	(	std::string	name,
		void *	val
	)

Sets the specified parameter to the given value.

Parameters:

name	Name of the parameter to be set.
val	Value the parameter should retain.

Definition at line 109 of file ALDOperator.cc.

Referenced by main(), Thres::operate(), DemoOperatorOpenCV::operate(), and Canny::operate().

void ALDOperator::validate

(

)

throw (ALDException)

Validates the parameters of this operator.

Definition at line 73 of file ALDOperator.cc.

References Alida::PARAMETER_IN, and Alida::PARAMETER_INOUT.

virtual void Alida::ALDOperator::validateCustom

(

)

[inline, virtual]

Operator specific validation of parameters which should be overridden.

Reimplemented in DemoOperator.

Definition at line 78 of file ALDOperator.h.

---

Member Data Documentation

std::map<std::string, ALDOpParameterDescriptor*> Alida::ALDOperator::parameters [protected]

Map containing list of registered parameters.

Definition at line 61 of file ALDOperator.h.

---

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

• operator/ALDOperator.h
• operator/ALDOperator.cc