Measurement Class Reference
[pydtn]

Encapsulation of a measurement as a value and variance/deviation. More...

#include <pydtn/Measurement.h>

List of all members.

Public Member Functions
	Measurement ()
	Default constructor; sets everything to zero.
	Measurement (double val, double var)
	Constructor for floating-point values.
	Measurement (unsigned long int val)
	Constructor for counting measurements.
	Measurement (const Measurement &m)
	Copy constructor.
virtual	~Measurement ()
	Destructor.
void	operator= (const Measurement &m)
	Assignment operator.
double	value () const
	Returns: the measurement value
double	variance () const
	Returns: the variance of the measurement
double	deviation () const
	Returns: the standard deviation of the measurement
bool	operator< (const Measurement &m) const
	Less-than operator.
bool	operator> (const Measurement &m) const
	Greater-than operator.
Mathematical operations
All of these operators assume the operands are independent quantities. If there are correlations, you're on your own.
Measurement	operator+ (const Measurement &m) const
	Addition operator.
Measurement	operator- (const Measurement &m) const
	Subtraction operator.
Measurement	operator * (const Measurement &m) const
	Multiplication operator.
Measurement	operator/ (const Measurement &m) const
	Division operator.

---

Detailed Description

Encapsulation of a measurement as a value and variance/deviation.

Definition at line 41 of file Measurement.h.

---

Constructor & Destructor Documentation

Measurement::Measurement	(	double	val,
		double	var
	)

Constructor for floating-point values.

Parameters:

	val	The measurement value
	var	The variance on val (the square of the standard deviation)

Definition at line 42 of file Measurement.cc.

Measurement::Measurement

(

unsigned long int

val

)

Constructor for counting measurements.

Parameters:

val

The count; equal to the variance

Definition at line 49 of file Measurement.cc.

Measurement::Measurement

(

const Measurement &

m

)

Copy constructor.

Parameters:

m

Another measurement

Definition at line 56 of file Measurement.cc.

---

Member Function Documentation

void Measurement::operator=

(

const Measurement &

m

)

Assignment operator.

Parameters:

m

Another measurement

Definition at line 68 of file Measurement.cc.

References m_sigma, m_value, and m_variance.

Measurement Measurement::operator+

(

const Measurement &

m

)

const

Addition operator.

Parameters:

m

The other addend

Returns:

the sum of this object and m, with error propagation

Definition at line 78 of file Measurement.cc.

References m_value, m_variance, and Measurement().

Measurement Measurement::operator-

(

const Measurement &

m

)

const

Subtraction operator.

Parameters:

m

The subtrahend

Returns:

the minuend (this object) minus the subtrahend (m), with error propagation

Definition at line 86 of file Measurement.cc.

References m_value, m_variance, and Measurement().

Measurement Measurement::operator *

(

const Measurement &

m

)

const

Multiplication operator.

Parameters:

m

The other multiplicand

Returns:

the product of this object and m, with error propagation

Definition at line 94 of file Measurement.cc.

References m_value, m_variance, and Measurement().

Measurement Measurement::operator/

(

const Measurement &

m

)

const

Division operator.

Parameters:

m

The divisor

Returns:

the dividend (this object) divided by the divisor (m), with error propagation

Definition at line 104 of file Measurement.cc.

References m_value, m_variance, and Measurement().

bool Measurement::operator<

(

const Measurement &

m

)

const

Less-than operator.

Parameters:

m

The other comparate

Return values:

	true	if this object's value is less than m
	false	otherwise

Definition at line 113 of file Measurement.cc.

References m_value.

bool Measurement::operator>

(

const Measurement &

m

)

const

Greater-than operator.

Parameters:

m

The other comparate

Return values:

	true	if this object's value is greater than m
	false	otherwise

Definition at line 119 of file Measurement.cc.

References m_value.

---

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

• pydtn/Measurement.h
• pydtn/Measurement.cc

---