AccumulationConverter Struct Reference

Converts raw data to values appropriate for accumulation. More...

#include <AccumulationConverter.h>

Inheritance diagram for AccumulationConverter:

Public Member Functions
virtual bool	decode (double &value) const
	Converts storage data to natural scale.
virtual bool	decode (double &value, double &weight) const
virtual void	encode (double &value, double &weight) const
	Converts natural-scale data to storage data, applying marker codes if needed.
virtual void	encodeWeight (double &weight) const
	Converts natural-scale data to storage data, applying marker codes if needed.
virtual void	encodeCount (double &weight) const
	Converts natural-scale data to storage data, applying marker codes if needed.
virtual void	encodeStdDev (double &stdDev) const
virtual void	encodeDiff (double &diff) const
	When using unsigned types, encoding typically requires adding a positive bias and scaling the data.
virtual double	getNoDataMarker () const =0
	Returns the value when weight==0.0. Physically, this relates to results obtained under measurement accuracy.
virtual double	getWeightNoDataMarker () const =0
virtual double	getNoReadingMarker () const =0
	Returns a marker value which indicates that although data has been measured, it is not within required accuracy or is otherways unreliable.
virtual std::ostream &	toOstr (std::ostream &ostr) const

Public Attributes
std::string	type
	Default output storage data type.

Detailed Description

Converts raw data to values appropriate for accumulation.

Member Function Documentation

decode() [1/2]

virtual bool decode ( double &  value ) const

inlinevirtual

Converts storage data to natural scale.

Parameters

value

- storage data, possibly containing marker codes

Returns

- true if data is valid for use, otherwise false.

Reimplemented in DataCoder.

decode() [2/2]

virtual bool decode ( double &  value, double &  weight  ) const

inlinevirtual

Converts storage data, possibly containing marker codes, to natural scale. Returns true if data is valid for use, otherwise false. Converts storage data to natural scale.

Parameters

value

- storage data, possibly containing marker codes

Returns

- true if data is valid for use, otherwise false.

Reimplemented in DataCoder.

encode()

virtual void encode ( double &  value, double &  weight  ) const

inlinevirtual

Converts natural-scale data to storage data, applying marker codes if needed.

Reimplemented in DataCoder.

encodeDiff()

virtual void encodeDiff ( double &  diff ) const

inlinevirtual

When using unsigned types, encoding typically requires adding a positive bias and scaling the data.

Reimplemented in DataCoder.

encodeWeight()

virtual void encodeWeight ( double &  weight ) const

inlinevirtual

Converts natural-scale data to storage data, applying marker codes if needed.

Reimplemented in DataCoder.

getNoDataMarker()

virtual double getNoDataMarker ( ) const

pure virtual

Returns the value when weight==0.0. Physically, this relates to results obtained under measurement accuracy.

Implemented in DataCoder.

getNoReadingMarker()

virtual double getNoReadingMarker ( ) const

pure virtual

Returns a marker value which indicates that although data has been measured, it is not within required accuracy or is otherways unreliable.

Implemented in DataCoder.

getWeightNoDataMarker()

virtual double getWeightNoDataMarker ( ) const

pure virtual

Unchecked code!

Implemented in DataCoder.

---

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

• src/drain/image/AccumulationConverter.h