cvr::normalDistribution::normalDistribution::parameters Class Reference

The parameters for the class normalDistribution. More...

#include <cvrNormalDistribution.h>

Inheritance diagram for cvr::normalDistribution::normalDistribution::parameters:

[legend]

Collaboration diagram for cvr::normalDistribution::normalDistribution::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 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
double	mean
double	sigma

---

Detailed Description

The parameters for the class normalDistribution.

---

Constructor & Destructor Documentation

cvr::normalDistribution::normalDistribution::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

cvr::normalDistribution::normalDistribution::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

cvr::normalDistribution::normalDistribution::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

---

Member Function Documentation

virtual parameters* cvr::normalDistribution::normalDistribution::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

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

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

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

(

)

const [virtual]

Returns the complete name of the parameters class.

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

virtual parameters* cvr::normalDistribution::normalDistribution::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

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

Reimplemented from cvr::randomDistribution::randomDistribution::parameters.

virtual bool cvr::normalDistribution::normalDistribution::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::randomDistribution::randomDistribution::parameters.

virtual bool cvr::normalDistribution::normalDistribution::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::randomDistribution::randomDistribution::parameters.

---

Member Data Documentation

double cvr::normalDistribution::normalDistribution::parameters::mean

Mean value of the distribution.

Default value: 0.0

double cvr::normalDistribution::normalDistribution::parameters::sigma

Standard deviation of the distribution.

The variance is the square of the standard deviation, and hence, the value you indicate here is the square root of the variance.

Default value: 1.0

---

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

• cvrNormalDistribution.h