face_contour_detector::filters::Parameter Class Reference

Describes a parameter of an filter and includes a pointer to set the parameter. More...

#include <Parameter.h>

List of all members.

Public Member Functions
bool *	GetBoolValuePtr () const
double *	GetDoubleValuePtr () const
int *	GetIntValuePtr () const
const std::string &	GetName () const
std::string	GetRulerMaximum ()
	Returns a reasonanle maximum value that a ui ruler could choose (if one hase been set, otherwise it returns a empty string)
std::string	GetRulerMinimum ()
	Returns a reasonanle minimum value that a ui ruler could choose (if one hase been set, otherwise it returns a empty string)
std::string *	GetStringValuePtr () const
ParameterType	GetType () const
	Parameter (const std::string &name, bool *ptr)
	Parameter (const std::string &name, int *ptr)
	Parameter (const std::string &name, int *ptr, int rulerMinimum, int rulerMaximum)
	Parameter (const std::string &name, double *ptr)
	Parameter (const std::string &name, double *ptr, double rulerMinimum, double rulerMaximum)
	Parameter (const std::string &name, std::string *ptr)
	Parameter (const Parameter &other)
Private Attributes
std::string	m_name
std::string	m_rulerMaximum
std::string	m_rulerMinimum
ParameterType	m_type
bool *	m_valuePtrB
double *	m_valuePtrD
int *	m_valuePtrI
std::string *	m_valuePtrS

---

Detailed Description

Describes a parameter of an filter and includes a pointer to set the parameter.

Definition at line 21 of file Parameter.h.

---

Constructor & Destructor Documentation

face_contour_detector::filters::Parameter::Parameter	(	const std::string &	name,
		bool *	ptr
	)		[inline]

Constructor for a bool parameter

Parameters:

name	the name of the parameter
ptr	pointer to the value of the filter

Definition at line 26 of file Parameter.h.

face_contour_detector::filters::Parameter::Parameter	(	const std::string &	name,
		int *	ptr
	)		[inline]

Constructor for a int parameter

Parameters:

name	the name of the parameter
ptr	pointer to the value of the filter

Definition at line 30 of file Parameter.h.

face_contour_detector::filters::Parameter::Parameter	(	const std::string &	name,
		int *	ptr,
		int	rulerMinimum,
		int	rulerMaximum
	)		[inline]

Constructor for a int parameter, with min and max for a ruler in an ui

Parameters:

name	the name of the parameter
ptr	pointer to the value of the filter
rulerMinimum	a reasonanle minimum value that a ui ruler can choose
rulerMaximum	a reasonanle maximum value that a ui ruler can choose

Definition at line 36 of file Parameter.h.

face_contour_detector::filters::Parameter::Parameter	(	const std::string &	name,
		double *	ptr
	)		[inline]

Constructor for a double parameter

Parameters:

name	the name of the parameter
ptr	pointer to the value of the filter

Definition at line 47 of file Parameter.h.

face_contour_detector::filters::Parameter::Parameter	(	const std::string &	name,
		double *	ptr,
		double	rulerMinimum,
		double	rulerMaximum
	)		[inline]

Constructor for a double parameter, with min and max for a ruler in an ui

Parameters:

name	the name of the parameter
ptr	pointer to the value of the filter
rulerMinimum	a reasonanle minimum value that a ui ruler can choose
rulerMaximum	a reasonanle maximum value that a ui ruler can choose

Definition at line 54 of file Parameter.h.

face_contour_detector::filters::Parameter::Parameter	(	const std::string &	name,
		std::string *	ptr
	)		[inline]

Constructor for a string parameter

Parameters:

name	the name of the parameter
ptr	pointer to the value of the filter

Definition at line 65 of file Parameter.h.

face_contour_detector::filters::Parameter::Parameter

(

const Parameter &

other

)

[inline]

Copy constructor

Parameters:

other

the paramter that is beeing copied

Definition at line 68 of file Parameter.h.

---

Member Function Documentation

bool* face_contour_detector::filters::Parameter::GetBoolValuePtr

(

)

const [inline]

if the parameter is a bool, this return a pointer to it

Precondition:

GetType() must be filter::TBOOL

Returns:

pointer to the parameter value

Definition at line 80 of file Parameter.h.

double* face_contour_detector::filters::Parameter::GetDoubleValuePtr

(

)

const [inline]

if the parameter is a double, this return a pointer to it

Precondition:

GetType() must be filter::TDOUBLE

Returns:

pointer to the parameter value

Definition at line 88 of file Parameter.h.

int* face_contour_detector::filters::Parameter::GetIntValuePtr

(

)

const [inline]

if the parameter is a int, this return a pointer to it

Precondition:

GetType() must be filter::TINT

Returns:

pointer to the parameter value

Definition at line 84 of file Parameter.h.

const std::string& face_contour_detector::filters::Parameter::GetName

(

)

const [inline]

Returns the name of the parameter

Returns:

reference to the name

Definition at line 72 of file Parameter.h.

std::string face_contour_detector::filters::Parameter::GetRulerMaximum

(

)

[inline]

Returns a reasonanle maximum value that a ui ruler could choose (if one hase been set, otherwise it returns a empty string)

Definition at line 96 of file Parameter.h.

std::string face_contour_detector::filters::Parameter::GetRulerMinimum

(

)

[inline]

Returns a reasonanle minimum value that a ui ruler could choose (if one hase been set, otherwise it returns a empty string)

Definition at line 94 of file Parameter.h.

std::string* face_contour_detector::filters::Parameter::GetStringValuePtr

(

)

const [inline]

if the parameter is a string, this return a pointer to it

Precondition:

GetType() must be filter::TSTRING

Returns:

pointer to the parameter value

Definition at line 92 of file Parameter.h.

ParameterType face_contour_detector::filters::Parameter::GetType

(

)

const [inline]

Returns the type of the paramter (TBOOL,TINT,TDOUBLE or TSTRING)

Returns:

type

Definition at line 75 of file Parameter.h.

---

Member Data Documentation

std::string face_contour_detector::filters::Parameter::m_name [private]

Definition at line 99 of file Parameter.h.

std::string face_contour_detector::filters::Parameter::m_rulerMaximum [private]

Definition at line 103 of file Parameter.h.

std::string face_contour_detector::filters::Parameter::m_rulerMinimum [private]

Definition at line 102 of file Parameter.h.

ParameterType face_contour_detector::filters::Parameter::m_type [private]

Definition at line 100 of file Parameter.h.

bool* face_contour_detector::filters::Parameter::m_valuePtrB [private]

Definition at line 106 of file Parameter.h.

double* face_contour_detector::filters::Parameter::m_valuePtrD [private]

Definition at line 108 of file Parameter.h.

int* face_contour_detector::filters::Parameter::m_valuePtrI [private]

Definition at line 107 of file Parameter.h.

std::string* face_contour_detector::filters::Parameter::m_valuePtrS [private]

Definition at line 109 of file Parameter.h.

---

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

• Parameter.h