cvr::validator::validator::parameters Class Reference

The parameters for the class validator. More...

#include <cvrValidator.h>

Inheritance diagram for cvr::validator::validator::parameters:

[legend]

Collaboration diagram for cvr::validator::validator::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual const std::string &	name () const
virtual functor::parameters *	clone () const
virtual functor::parameters *	newInstance () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Static Public Member Functions
static bool	defaultValidateDouble (double x)
static bool	defaultValidateFloat (float x)
Public Attributes
doubleValidator *	isDoubleValid
floatValidator *	isFloatValid

---

Detailed Description

The parameters for the class validator.

---

Constructor & Destructor Documentation

cvr::validator::validator::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::functor::functor::parameters.

cvr::validator::validator::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

cvr::validator::validator::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::functor::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* cvr::validator::validator::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::functor::functor::parameters.

parameters& cvr::validator::validator::parameters::copy

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

static bool cvr::validator::validator::parameters::defaultValidateDouble

(

double

x

)

[static]

Default function to check the validity of a double value.

static bool cvr::validator::validator::parameters::defaultValidateFloat

(

float

x

)

[static]

Default function to check the validity of a float value.

virtual const std::string& cvr::validator::validator::parameters::name

(

)

const [virtual]

Returns the name of this class.

Implements cvr::functor::functor::parameters.

virtual functor::parameters* cvr::validator::validator::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::functor::functor::parameters.

parameters& cvr::validator::validator::parameters::operator=

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

virtual bool cvr::validator::validator::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Read the parameters from the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::parametersManager::parametersManager::parameters.

virtual bool cvr::validator::validator::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::parametersManager::parametersManager::parameters.

---

Member Data Documentation

doubleValidator* cvr::validator::validator::parameters::isDoubleValid

Pointer to a C function or a static member function that evaluates if a value is a valid floating point representation for the double type.

Default value: defaultValidateDouble()

floatValidator* cvr::validator::validator::parameters::isFloatValid

Pointer to a C function or a static member function that evaluates if a value is a valid floating point representation for the float type.

Default value: defaultValidateFloat()

---

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

• cvrValidator.h