InstanceId Class Reference

Detailed Description

The ID of a particular VuMark instance.

Public Types
enum	ID_DATA_TYPE {   BYTES = 0,   STRING = 1,   NUMERIC = 2 }
	The type of data encoded in this ID. More...

Public Member Functions
virtual const char *	getBuffer () const =0
	Get a char buffer filled with getLength() bytes representing the InstanceId. More...
virtual size_t	getLength () const =0
	Get the length of the id's data, in bytes. More...
virtual unsigned long long	getNumericValue () const =0
	Convenience method to get IDs of type NUMERIC. More...
virtual ID_DATA_TYPE	getDataType () const =0
	Get the type of data this instance ID stores. More...

Member Enumeration Documentation

enum ID_DATA_TYPE

The type of data encoded in this ID.

Enumerator
BYTES	Generic byte data, stored in little-endian order in the buffer. For example, and ID of 0x123456 would appear as { 0x56, 0x34, 0x12 }
STRING	Printable string data in ASCII.
NUMERIC	Numeric data, not larger than a 64 bit unsigned long long.

Member Function Documentation

virtual const char* getBuffer ( ) const

pure virtual

Get a char buffer filled with getLength() bytes representing the InstanceId.

virtual size_t getLength ( ) const

pure virtual

Get the length of the id's data, in bytes.

virtual unsigned long long getNumericValue ( ) const

pure virtual

Convenience method to get IDs of type NUMERIC.

Returns

The ID if its type is NUMERIC, otherwise 0.

virtual ID_DATA_TYPE getDataType ( ) const

pure virtual

Get the type of data this instance ID stores.