DtRecordSet Class Reference

Instances of DtRecordSet are used to contain the record sets used by the PDU classes which inherit from the record set PDU base class. More...

Collaboration diagram for DtRecordSet:

List of all members.

Public Member Functions
	DtRecordSet ()
	Constructors.
	DtRecordSet (const DtRecordSet &orig)
virtual	~DtRecordSet ()
	Destructor.
DtRecordSet &	operator= (const DtRecordSet &orig)
	Assignment operators.
DtRecordSet &	operator= (const DtNetRecordSet &orig)
virtual bool	setDatumID (DtDatumParam value)
	Set/Get the datum ID.
virtual DtDatumParam	datumID () const
virtual void	setSerialNumber (DtU32 value)
	Set/Get the serial number.
virtual DtU32	serialNumber () const
virtual bool	setRecordBitLength (DtU16 bitLength)
	Set/Get the record length in bits.
virtual DtU16	recordBitLength () const
virtual bool	setRecordByteLength (int byteLength)
	Set/Get the record length in bytes.
virtual int	recordByteLength () const
virtual bool	setRecordCount (DtU32 bytes)
	Set/Get the number of of records in this set.
virtual DtU32	recordCount () const
virtual bool	setDataBytes (DtU32 recordIndex, const void *data)
	Set/Get multiple data bytes.
virtual bool	getDataBytes (DtU32 recordIndex, void *buff) const
virtual bool	setDataByte (DtU32 recordIndex, DtU8 value, int byteIndex=0)
	Set/Get a data byte.
virtual bool	getDataByte (DtU32 recordIndex, DtU8 &value, int byteIndex=0) const
virtual bool	setDataInt16 (DtU32 recordIndex, DtInt16 &value)
	Set/Get data in signed 16-bit integer format.
virtual bool	getDataInt16 (DtU32 recordIndex, DtInt16 &value) const
virtual bool	setDataU16 (DtU32 recordIndex, DtU16 &value)
	Set/Get data in unsigned 16-bit integer format.
virtual bool	getDataU16 (DtU32 recordIndex, DtU16 &value) const
virtual bool	setDataInt32 (DtU32 recordIndex, DtInt32 &value)
	Set/Get data in signed 32-bit integer format.
virtual bool	getDataInt32 (DtU32 recordIndex, DtInt32 &value) const
virtual bool	setDataU32 (DtU32 recordIndex, DtU32 &value)
	Set/Get data in unsigned 32-bit integer format.
virtual bool	getDataU32 (DtU32 recordIndex, DtU32 &value) const
virtual bool	setDataFloat32 (DtU32 recordIndex, DtFloat32 &value)
	Set/Get data in 32-bit floating point format.
virtual bool	getDataFloat32 (DtU32 recordIndex, DtFloat32 &value) const
virtual bool	setDataFloat64 (DtU32 recordIndex, DtFloat64 &value)
	Set/Get data in 64-bit floating point format.
virtual bool	getDataFloat64 (DtU32 recordIndex, DtFloat64 &value) const
virtual int	recordSetLength () const
	Get the total number of bytes required for the network representation of the record set.
virtual void	print () const
	Print this record.
virtual void	printDataToStream (std::ostream &stream) const
virtual void	unloadNetRecordSet (const DtNetRecordSet &record)
	Load/unload data from a packet record.
virtual void	loadNetRecordSet (DtNetRecordSet &record) const
Protected Attributes
DtDatumParam	myDatumID
DtU32	mySerialNumber
DtU16	myRecordLength
DtU32	myRecordCount
char *	myData

---

Detailed Description

Instances of DtRecordSet are used to contain the record sets used by the PDU classes which inherit from the record set PDU base class.

---

Constructor & Destructor Documentation

DtRecordSet::DtRecordSet

(

)

Constructors.

DtRecordSet::DtRecordSet

(

const DtRecordSet &

orig

)

virtual DtRecordSet::~DtRecordSet

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual DtDatumParam DtRecordSet::datumID

(

)

const [virtual]

virtual bool DtRecordSet::getDataByte	(	DtU32	recordIndex,
		DtU8 &	value,
		int	byteIndex = 0
	)		const [virtual]

virtual bool DtRecordSet::getDataBytes	(	DtU32	recordIndex,
		void *	buff
	)		const [virtual]

virtual bool DtRecordSet::getDataFloat32	(	DtU32	recordIndex,
		DtFloat32 &	value
	)		const [virtual]

virtual bool DtRecordSet::getDataFloat64	(	DtU32	recordIndex,
		DtFloat64 &	value
	)		const [virtual]

virtual bool DtRecordSet::getDataInt16	(	DtU32	recordIndex,
		DtInt16 &	value
	)		const [virtual]

virtual bool DtRecordSet::getDataInt32	(	DtU32	recordIndex,
		DtInt32 &	value
	)		const [virtual]

virtual bool DtRecordSet::getDataU16	(	DtU32	recordIndex,
		DtU16 &	value
	)		const [virtual]

virtual bool DtRecordSet::getDataU32	(	DtU32	recordIndex,
		DtU32 &	value
	)		const [virtual]

virtual void DtRecordSet::loadNetRecordSet

(

DtNetRecordSet &

record

)

const [virtual]

DtRecordSet& DtRecordSet::operator=

(

const DtRecordSet &

orig

)

Assignment operators.

DtRecordSet& DtRecordSet::operator=

(

const DtNetRecordSet &

orig

)

virtual void DtRecordSet::print

(

)

const [virtual]

Print this record.

virtual void DtRecordSet::printDataToStream

(

std::ostream &

stream

)

const [virtual]

virtual DtU16 DtRecordSet::recordBitLength

(

)

const [virtual]

virtual int DtRecordSet::recordByteLength

(

)

const [virtual]

virtual DtU32 DtRecordSet::recordCount

(

)

const [virtual]

virtual int DtRecordSet::recordSetLength

(

)

const [virtual]

Get the total number of bytes required for the network representation of the record set.

virtual DtU32 DtRecordSet::serialNumber

(

)

const [virtual]

virtual bool DtRecordSet::setDataByte	(	DtU32	recordIndex,
		DtU8	value,
		int	byteIndex = 0
	)		[virtual]

Set/Get a data byte.

These functions return false if the record index or byte index is out of range.

virtual bool DtRecordSet::setDataBytes	(	DtU32	recordIndex,
		const void *	data
	)		[virtual]

Set/Get multiple data bytes.

Provide a pointer and data is copied to and from that memory. Will copy recordByteLength() bytes on set/get. These functions return false if the record index is out of range.

virtual bool DtRecordSet::setDataFloat32	(	DtU32	recordIndex,
		DtFloat32 &	value
	)		[virtual]

Set/Get data in 32-bit floating point format.

These functions return false if the record length is not 32-bits, or if the record index is out of range.

virtual bool DtRecordSet::setDataFloat64	(	DtU32	recordIndex,
		DtFloat64 &	value
	)		[virtual]

Set/Get data in 64-bit floating point format.

These functions return false if the record length is not 64-bits, or if the record index is out of range.

virtual bool DtRecordSet::setDataInt16	(	DtU32	recordIndex,
		DtInt16 &	value
	)		[virtual]

Set/Get data in signed 16-bit integer format.

These functions return false if the record length is not 16-bits, or if the record index is out of range.

virtual bool DtRecordSet::setDataInt32	(	DtU32	recordIndex,
		DtInt32 &	value
	)		[virtual]

Set/Get data in signed 32-bit integer format.

These functions return false if the record length is not 32-bits, or if the record index is out of range.

virtual bool DtRecordSet::setDataU16	(	DtU32	recordIndex,
		DtU16 &	value
	)		[virtual]

Set/Get data in unsigned 16-bit integer format.

These functions return false if the record length is not 16-bits, or if the record index is out of range.

virtual bool DtRecordSet::setDataU32	(	DtU32	recordIndex,
		DtU32 &	value
	)		[virtual]

Set/Get data in unsigned 32-bit integer format.

These functions return false if the record length is not 32-bits, or if the record index is out of range.

virtual bool DtRecordSet::setDatumID

(

DtDatumParam

value

)

[virtual]

Set/Get the datum ID.

virtual bool DtRecordSet::setRecordBitLength

(

DtU16

bitLength

)

[virtual]

Set/Get the record length in bits.

setRecordBitLength() also resets the number of records to zero, and may return false (with no action) if the length is invalid.

virtual bool DtRecordSet::setRecordByteLength

(

int

byteLength

)

[virtual]

Set/Get the record length in bytes.

setRecordLength() also resets the number of records to zero, and may return false (with no action) if the length is invalid.

virtual bool DtRecordSet::setRecordCount

(

DtU32

bytes

)

[virtual]

Set/Get the number of of records in this set.

When the number of records is changed, old records are not preserved.

virtual void DtRecordSet::setSerialNumber

(

DtU32

value

)

[virtual]

Set/Get the serial number.

virtual void DtRecordSet::unloadNetRecordSet

(

const DtNetRecordSet &

record

)

[virtual]

Load/unload data from a packet record.

---

Member Data Documentation

char* DtRecordSet::myData [protected]

DtDatumParam DtRecordSet::myDatumID [protected]

DtU32 DtRecordSet::myRecordCount [protected]

DtU16 DtRecordSet::myRecordLength [protected]

DtU32 DtRecordSet::mySerialNumber [protected]

---

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

• recordSet.h