te::process::ParameterDescriptor Class Reference

#include <ParameterDescriptor.h>

Public Types
enum	Direction { Direction::INPUT, Direction::OUTPUT }

Public Member Functions
int	getDataType () const
	Sets the parameter data type. More...
const ParameterValue *	getDefaultValue () const
	Sets the default value. This object wille TAKE THE OWNERSHIP of the pointer. More...
const std::string	getDescription () const
	Sets the parameter description. More...
Direction	getDirection () const
	Sets the parameter type. More...
const std::string	getName () const
	Sets the parameter name. More...
bool	isRequired () const
	Sets the parameter to be required. More...
bool	isValueValid (const te::process::ParameterValue *value) const
virtual ParameterDescriptor &	operator= (const ParameterDescriptor &rhs)
	Gets the parameter name. More...
	ParameterDescriptor (const std::string &name="", int dataType=te::dt::UNKNOWN_TYPE, bool isRequired=true, Direction type=Direction::INPUT)
	Copy constructor. More...
	ParameterDescriptor (const ParameterDescriptor &rhs)
void	setDataType (int dataType)
	Checks if the parameter is required. More...
void	setDefaultValue (ParameterValue *defaultValue)
	Checks if the given value is valid basedon the descriptor metadata. More...
void	setDescription (const std::string &description)
	Gets the parameter data type. More...
void	setDirection (Direction direction)
	Gets the default value. If not set, returns null. More...
void	setName (const std::string &name)
	Gets the parameter description. More...
void	setRequired (bool required)
	Gets the parameter type. More...
virtual	~ParameterDescriptor ()
	Virtual destructor. More...

Protected Attributes
int	m_dataType
std::unique_ptr< ParameterValue >	m_defaultValue
std::string	m_description
Direction	m_direction
bool	m_isRequired
std::string	m_name

Detailed Description

Definition at line 49 of file ParameterDescriptor.h.

Member Enumeration Documentation

Direction

enum te::process::ParameterDescriptor::Direction

strong

Enumerator
INPUT
OUTPUT

Definition at line 53 of file ParameterDescriptor.h.

Constructor & Destructor Documentation

ParameterDescriptor() [1/2]

te::process::ParameterDescriptor::ParameterDescriptor	(	const std::string &	name = "",
		int	dataType = te::dt::UNKNOWN_TYPE,
		bool	isRequired = true,
		Direction	type = Direction::INPUT
	)

Copy constructor.

ParameterDescriptor() [2/2]

te::process::ParameterDescriptor::ParameterDescriptor

(

const ParameterDescriptor &

rhs

)

~ParameterDescriptor()

virtual te::process::ParameterDescriptor::~ParameterDescriptor ( )

virtual

Virtual destructor.

Assigment operator

Member Function Documentation

getDataType()

int te::process::ParameterDescriptor::getDataType

(

)

const

Sets the parameter data type.

getDefaultValue()

const ParameterValue* te::process::ParameterDescriptor::getDefaultValue

(

)

const

Sets the default value. This object wille TAKE THE OWNERSHIP of the pointer.

getDescription()

const std::string te::process::ParameterDescriptor::getDescription

(

)

const

Sets the parameter description.

getDirection()

Direction te::process::ParameterDescriptor::getDirection

(

)

const

Sets the parameter type.

getName()

const std::string te::process::ParameterDescriptor::getName

(

)

const

Sets the parameter name.

isRequired()

bool te::process::ParameterDescriptor::isRequired

(

)

const

Sets the parameter to be required.

isValueValid()

bool te::process::ParameterDescriptor::isValueValid

(

const te::process::ParameterValue *

value

)

const

operator=()

virtual ParameterDescriptor& te::process::ParameterDescriptor::operator= ( const ParameterDescriptor &  rhs )

virtual

Gets the parameter name.

setDataType()

void te::process::ParameterDescriptor::setDataType

(

int

dataType

)

Checks if the parameter is required.

setDefaultValue()

void te::process::ParameterDescriptor::setDefaultValue

(

ParameterValue *

defaultValue

)

Checks if the given value is valid basedon the descriptor metadata.

setDescription()

void te::process::ParameterDescriptor::setDescription

(

const std::string &

description

)

Gets the parameter data type.

setDirection()

void te::process::ParameterDescriptor::setDirection

(

Direction

direction

)

Gets the default value. If not set, returns null.

setName()

void te::process::ParameterDescriptor::setName

(

const std::string &

name

)

Gets the parameter description.

setRequired()

void te::process::ParameterDescriptor::setRequired

(

bool

required

)

Gets the parameter type.

Member Data Documentation

m_dataType

int te::process::ParameterDescriptor::m_dataType

protected

Definition at line 110 of file ParameterDescriptor.h.

m_defaultValue

std::unique_ptr<ParameterValue> te::process::ParameterDescriptor::m_defaultValue

protected

Definition at line 113 of file ParameterDescriptor.h.

m_description

std::string te::process::ParameterDescriptor::m_description

protected

Definition at line 109 of file ParameterDescriptor.h.

m_direction

Direction te::process::ParameterDescriptor::m_direction

protected

Definition at line 112 of file ParameterDescriptor.h.

m_isRequired

bool te::process::ParameterDescriptor::m_isRequired

protected

Definition at line 111 of file ParameterDescriptor.h.

m_name

std::string te::process::ParameterDescriptor::m_name

protected

Definition at line 108 of file ParameterDescriptor.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/process/ParameterDescriptor.h