om::lang::UserData Class Reference

A class that wraps opaque client data that represents a pointer or an integer. More...

#include <omUserData.h>

Public Member Functions
	UserData ()
	Create a user data object that is NULL. More...
	UserData (Index newIndex)
	Create a user data object that refers to the specified index. More...
	UserData (void *newPointer)
	Create a user data object that refers to the specified pointer. More...

Public Attributes
union {
Int8   int8
UInt8   uint8
Int16   int16
UInt16   uint16
Int32   int32
UInt32   uint32
Int64   int64
UInt64   uint64
Float32   float32
Float64   float64
Index   index
Size   size
void *   pointer
};
	A union that contains the various possible representations of the user data. More...

Detailed Description

A class that wraps opaque client data that represents a pointer or an integer.

Client-specific data is often needed by the user of a complex system that requires callbacks in order to identify an object or provide an opaque data source. This class provides a uniform mechanism for storing either an opaque pointer or integer to client data. The class stores at least 64 bits of information.

Constructor & Destructor Documentation

om::lang::UserData::UserData ( )

inline

Create a user data object that is NULL.

om::lang::UserData::UserData ( Index  newIndex )

inline

Create a user data object that refers to the specified index.

om::lang::UserData::UserData ( void *  newPointer )

inline

Create a user data object that refers to the specified pointer.

Member Data Documentation

Int8 om::lang::UserData::int8

UInt8 om::lang::UserData::uint8

Int16 om::lang::UserData::int16

UInt16 om::lang::UserData::uint16

Int32 om::lang::UserData::int32

UInt32 om::lang::UserData::uint32

Int64 om::lang::UserData::int64

UInt64 om::lang::UserData::uint64

Float32 om::lang::UserData::float32

Float64 om::lang::UserData::float64

Index om::lang::UserData::index

Size om::lang::UserData::size

void* om::lang::UserData::pointer

union { ... }

A union that contains the various possible representations of the user data.

---

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

• omUserData.h