RECORDBUFFER_MSBFIRST Class Reference

Record buffer where values are stored with most-significant byte first (big-endian / Network order). More...

#include <mi32/recordbuffer.h>

Inheritance diagram for RECORDBUFFER_MSBFIRST:

Public Member Functions
template<typename _TT >
void	GetComposite (int offset, _TT *values, int numvalues) const
template<typename _TT >
void	GetComposite (int offset, _TT &value) const
void	GetDouble (int offset, double *values, int numvalues)
double	GetDouble (int offset)
void	GetFloat (int offset, float *values, int numvalues)
float	GetFloat (int offset)
void	GetINT16 (int offset, INT16 *values, int numvalues)
INT16	GetINT16 (int offset)
void	GetINT32 (int offset, INT32 *values, int numvalues)
INT32	GetINT32 (int offset)
void	GetUINT16 (int offset, UINT16 *values, int numvalues)
UINT16	GetUINT16 (int offset)
void	GetUINT32 (int offset, UINT32 *values, int numvalues)
UINT32	GetUINT32 (int offset)
template<typename _TT >
void	PutComposite (int offset, const _TT *values, int numvalues)
template<typename _TT >
void	PutComposite (int offset, _TT value)
void	PutDouble (int offset, const double *values, int numvalues)
void	PutDouble (int offset, double value)
void	PutFloat (int offset, const float *values, int numvalues)
void	PutFloat (int offset, float value)
void	PutINT16 (int offset, const INT16 *values, int numvalues)
void	PutINT16 (int offset, INT16 value)
void	PutINT32 (int offset, const INT32 *values, int numvalues)
void	PutINT32 (int offset, INT32 value)
void	PutUINT16 (int offset, const UINT16 *values, int numvalues)
void	PutUINT16 (int offset, UINT16 value)
void	PutUINT32 (int offset, const UINT32 *values, int numvalues)
void	PutUINT32 (int offset, UINT32 value)

Detailed Description

Record buffer where values are stored with most-significant byte first (big-endian / Network order).

This class is intended to be used to store data in a format for working with external files where values are stored most-significant byte first and that may not be aligned.

Member Function Documentation

template<typename _TT >

void RECORDBUFFER_MSBFIRST::GetComposite	(	int	offset,
		_TT *	values,
		int	numvalues
	)			const `[inline]`

Get composite array values from record.

There must be a SwapBytes(...) method defined for the composite type. Items are byte-copied, so check alignment issues carefully.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Array of values returned Number of values

template<typename _TT >

void RECORDBUFFER_MSBFIRST::GetComposite	(	int	offset,
		_TT &	value
	)			const `[inline]`

Get composite value from record.

There must be a SwapBytes(...) method defined for the composite type. Item is byte-copied, so check alignment issues carefully.

Parameters:

value

Byte offset to value, not validated Value returned

void RECORDBUFFER_MSBFIRST::GetDouble	(	int	offset,
		double *	values,
		int	numvalues
	)			`[inline]`

Get double array values from record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Array of values returned Number of values

double RECORDBUFFER_MSBFIRST::GetDouble ( int offset ) [inline]

Get double value from record.

Parameters:

offset

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::GetFloat	(	int	offset,
		float *	values,
		int	numvalues
	)			`[inline]`

Get float array values from record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Array of values returned Number of values

float RECORDBUFFER_MSBFIRST::GetFloat ( int offset ) [inline]

Get float value from record.

Parameters:

offset

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::GetINT16	(	int	offset,
		INT16 *	values,
		int	numvalues
	)			`[inline]`

Get INT16 array values from record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Array of values returned Number of values

INT16 RECORDBUFFER_MSBFIRST::GetINT16 ( int offset ) [inline]

Get INT16 value from record.

Parameters:

offset

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::GetINT32	(	int	offset,
		INT32 *	values,
		int	numvalues
	)			`[inline]`

Get INT32 array values from record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Array of values returned Number of values

INT32 RECORDBUFFER_MSBFIRST::GetINT32 ( int offset ) [inline]

Get INT32 value from record.

Parameters:

offset

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::GetUINT16	(	int	offset,
		UINT16 *	values,
		int	numvalues
	)			`[inline]`

Get UINT16 array values from record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Array of values returned Number of values

UINT16 RECORDBUFFER_MSBFIRST::GetUINT16 ( int offset ) [inline]

Get UINT16 value from record.

Parameters:

offset

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::GetUINT32	(	int	offset,
		UINT32 *	values,
		int	numvalues
	)			`[inline]`

Get UINT32 array values from record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Array of values returned Number of values

UINT32 RECORDBUFFER_MSBFIRST::GetUINT32 ( int offset ) [inline]

Get UINT32 value from record.

Parameters:

offset

Byte offset to value, not validated

template<typename _TT >

void RECORDBUFFER_MSBFIRST::PutComposite	(	int	offset,
		const _TT *	values,
		int	numvalues
	)			`[inline]`

Put composite array values into record.

There must be a SwapBytes(...) method defined for the composite type. Items are byte-copied, so check alignment issues carefully.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Number of values

template<typename _TT >

void RECORDBUFFER_MSBFIRST::PutComposite	(	int	offset,
		_TT	value
	)			`[inline]`

Put composite value into record.

There must be a SwapBytes(...) method defined for the composite type. Item is byte-copied, so check alignment issues carefully.

Parameters:

value

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::PutDouble	(	int	offset,
		const double *	values,
		int	numvalues
	)			`[inline]`

Put double array values into record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Number of values

void RECORDBUFFER_MSBFIRST::PutDouble	(	int	offset,
		double	value
	)			`[inline]`

Put double value into record.

Parameters:

value

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::PutFloat	(	int	offset,
		const float *	values,
		int	numvalues
	)			`[inline]`

Put float array values into record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Number of values

void RECORDBUFFER_MSBFIRST::PutFloat	(	int	offset,
		float	value
	)			`[inline]`

Put float value into record.

Parameters:

value

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::PutINT16	(	int	offset,
		const INT16 *	values,
		int	numvalues
	)			`[inline]`

Put INT16 array values into record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Number of values

void RECORDBUFFER_MSBFIRST::PutINT16	(	int	offset,
		INT16	value
	)			`[inline]`

Put INT16 value into record.

Parameters:

value

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::PutINT32	(	int	offset,
		const INT32 *	values,
		int	numvalues
	)			`[inline]`

Put INT32 array values into record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Number of values

void RECORDBUFFER_MSBFIRST::PutINT32	(	int	offset,
		INT32	value
	)			`[inline]`

Put INT32 value into record.

Parameters:

value

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::PutUINT16	(	int	offset,
		const UINT16 *	values,
		int	numvalues
	)			`[inline]`

Put UINT16 array values into record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Number of values

void RECORDBUFFER_MSBFIRST::PutUINT16	(	int	offset,
		UINT16	value
	)			`[inline]`

Put UINT16 value into record.

Parameters:

value

Byte offset to value, not validated

void RECORDBUFFER_MSBFIRST::PutUINT32	(	int	offset,
		const UINT32 *	values,
		int	numvalues
	)			`[inline]`

Put UINT32 array values into record.

Parameters:

	values	Byte offset to first value, not validated
	numvalues	Number of values

void RECORDBUFFER_MSBFIRST::PutUINT32	(	int	offset,
		UINT32	value
	)			`[inline]`

Put UINT32 value into record.

Parameters:

value

Byte offset to value, not validated

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

mi32/recordbuffer.h

RECORDBUFFER_MSBFIRST Class Reference

Public Member Functions

Detailed Description

Member Function Documentation