Methods for conversion to/from scaled integers and real numbers. More...

#include <scaledinteger.h>

Public Types
enum	Type { Byte = 10, Short, UShort, Int, UInt, Long, ULong }
	Enumerations of the different types of scaled integers. More...
Static Public Member Functions
static int	Write (Packet &packet, const LongFloat real, const LongFloat upper, const LongFloat lower, const Type type, const unsigned int pos=UINT_MAX)
	Convert a floating point value to a scaled integer and write to the packet.
static int	Read (const Packet &packet, LongFloat &val, const LongFloat upper, const LongFloat lower, const ScaledInteger::Type type, const unsigned int pos=UINT_MAX)
	Read a real number at the index in the packet that is a scaled int.
static double	ToDouble (const JAUS::Byte scaled, const double upper, const double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static float	ToFloat (const JAUS::Byte scaled, const double upper, const double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static JAUS::Byte	ToScaledByte (const double real, const double upper, const double lower)
	Converts from a real number to a Scaled Integer value.
static JAUS::Byte	ToScaledByte (const float real, const float upper, const float lower)
	Converts from a real number to a Scaled Integer value.
static double	ToDouble (const JAUS::Short scaled, const double upper, const double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static float	ToFloat (const JAUS::Short scaled, const double upper, const double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static JAUS::Short	ToScaledShort (const double real, const double upper, const double lower)
	Converts from a real number to a Scaled Integer value.
static JAUS::Short	ToScaledShort (const float real, const float upper, const float lower)
	Converts from a real number to a Scaled Integer value.
static double	ToDouble (const JAUS::UShort scaled, const double upper, const double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static float	ToFloat (const JAUS::UShort scaled, const double upper, const double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static JAUS::UShort	ToScaledUShort (const double real, const double upper, const double lower)
	Converts from a real number to a Scaled Integer value.
static JAUS::UShort	ToScaledUShort (const float real, const float upper, const float lower)
	Converts from a real number to a Scaled Integer value.
static double	ToDouble (const JAUS::Int scaled, double upper, double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static float	ToFloat (const JAUS::Int scaled, const float upper, const float lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static JAUS::Int	ToScaledInt (const double real, double upper, double lower)
	Converts from a real number to a Scaled Integer value.
static JAUS::Int	ToScaledInt (const float real, const float upper, const float lower)
	Converts from a real number to a Scaled Integer value.
static double	ToDouble (const JAUS::UInt scaled, double upper, double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static float	ToFloat (const JAUS::UInt scaled, const float upper, const float lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static JAUS::UInt	ToScaledUInt (const double real, double upper, double lower)
	Converts from a real number to a Scaled Integer value.
static JAUS::UInt	ToScaledUInt (const float real, const float upper, const float lower)
	Converts from a real number to a Scaled Integer value.
static double	ToDouble (const JAUS::Long scaled, double upper, double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static float	ToFloat (const JAUS::Long scaled, const float upper, const float lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static JAUS::Long	ToScaledLong (const double real, double upper, double lower)
	Converts from a real number to a Scaled Integer value.
static JAUS::Long	ToScaledLong (const float real, const float upper, const float lower)
	Converts from a real number to a Scaled Integer value.
static double	ToDouble (const JAUS::ULong scaled, double upper, double lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static float	ToFloat (const JAUS::ULong scaled, const float upper, const float lower)
	Converts a scaled integer to a real number based on the upper and lower limits of the real number.
static JAUS::ULong	ToScaledULong (const double real, double upper, double lower)
	Converts from a real number to a Scaled Integer value.
static JAUS::ULong	ToScaledULong (const float real, const float upper, const float lower)
	Converts from a real number to a Scaled Integer value.

Detailed Description

Methods for conversion to/from scaled integers and real numbers.

Definition at line 55 of file scaledinteger.h.

Member Enumeration Documentation

enum JAUS::ScaledInteger::Type

Enumerations of the different types of scaled integers.

Enumerator:

Byte
Short
UShort
Int
UInt
Long
ULong

Definition at line 64 of file scaledinteger.h.

Member Function Documentation

static int JAUS::ScaledInteger::Read	(	const Packet &	packet,
		LongFloat &	val,
		const LongFloat	upper,
		const LongFloat	lower,
		const ScaledInteger::Type	type,
		const unsigned int	pos = `UINT_MAX`
	)		`[inline, static]`

Read a real number at the index in the packet that is a scaled int.

Parameters:

[in]	packet	The packet to read from.
[out]	val	The value read.
[in]	upper	The upper limit of real.
[in]	lower	The lower limit of real.
[in]	type	What type of scaled integer to convert from (ScaledInteger::Int, ScaledInteger::UInt, ScaledInteger::Short, ScaledInteger::UShort, or ScaledInteger::Byte).
[in]	pos	The byte position within the stream to read at. If pos is equal to UINT_MAX, then the internal read position is used, which is the default behavior.

Returns:: The number of bytes read, 0 if nothing read.

Definition at line 161 of file scaledinteger.h.

static double JAUS::ScaledInteger::ToDouble	(	const JAUS::UShort	scaled,
		const double	upper,
		const double	lower
	)		`[inline, static]`