cvr::quickMedian::quickMedian::parameters Class Reference

The parameters for the class quickMedian. More...

#include <cvrQuickMedian.h>

Inheritance diagram for cvr::quickMedian::quickMedian::parameters:

[legend]

Collaboration diagram for cvr::quickMedian::quickMedian::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const std::string &	name () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual parameters *	clone () const
virtual parameters *	newInstance () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eMedianEvenCase	medianEvenCase

---

Detailed Description

The parameters for the class quickMedian.

---

Constructor & Destructor Documentation

cvr::quickMedian::quickMedian::parameters::parameters

(

)

Default constructor.

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

cvr::quickMedian::quickMedian::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

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

cvr::quickMedian::quickMedian::parameters::~parameters

(

)

[virtual]

destructor

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

---

Member Function Documentation

virtual parameters* cvr::quickMedian::quickMedian::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

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

parameters& cvr::quickMedian::quickMedian::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

const std::string& cvr::quickMedian::quickMedian::parameters::name

(

)

const [virtual]

Returns the name of this class.

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

virtual parameters* cvr::quickMedian::quickMedian::parameters::newInstance

(

)

const [virtual]

returns a pointer to a new instance of the parameters

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

parameters& cvr::quickMedian::quickMedian::parameters::operator=

(

const parameters &

other

)

Alias for copy member.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

virtual bool cvr::quickMedian::quickMedian::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::quickMedian::quickMedian::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

eMedianEvenCase cvr::quickMedian::quickMedian::parameters::medianEvenCase

Specifies how to consider the case when the number of elements of the vector is even (see cvr::eMedianEvenCase).

This parameter has no effect for odd-sized vectors.

Default value: TakeLower

---

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

• cvrQuickMedian.h