XmAtom Class Reference

Inheritance diagram for XmAtom:

List of all members.

Detailed Description

Used to encapsulate native atomic data (int, bool, float,...).

All atomic data such like int, bool, float... can be handled by the exom framework, if they are encapsulated via an instances of this class, before using it. An XmAtom instance store the type and the pointer of atomic data. Normally you will use this class only to do conversions between the three different data formats

native data
string
bytes arrays.

Conversions are useful when handling parameters in user interface. The concerned classes for handling parameters are XmFcnParams and XmParamAccess. The exom framework support all available simple data formats, but you are able to introduce your own data types, by setting your own XmAtomHandler.

Public Member Functions

ATOM_TYPE GetType () const

Return the type of an atom.

void * GetPt () const

Return the pointer to an atmo.

void SetAtomAttrib (void *pt, ATOM_TYPE type)

Encapsulate an atom.

XmAtom ()

Construct an undefined atom.

XmAtom (void *pt, ATOM_TYPE type)

Construct an atom encpasulating the given data.

bool CopyToBool (bool &i) const

Copy the value of the encapsulated atom to an boolean.

bool CopyToInt8 (xmInt8 &i) const

Copy value of the encapsulated atom to a integer.

bool CopyToInt16 (xmInt16 &i) const

Copy value of the encapsulated atom to an integer.

bool CopyToInt32 (xmInt32 &i) const

Copy value of the encapsulated atom to an integer.

bool CopyToUInt8 (xmUInt8 &i) const

Copy value of the encapsulated atom to an integer.

bool CopyToUInt16 (xmUInt16 &i) const

Copy value of the encapsulated atom to an integer.

bool CopyToUInt32 (xmUInt32 &i) const

Copy value of the encapsulated atom to an integer.

bool CopyToString (XmString &i) const

Copy value of the encapsulated atom to a string.

bool CopyToTime32 (XmTime32 &i) const

Copy value of the encapsulated atom to a time.

bool CopyToAByte (XmAByte &i) const

Copy value of the encapsulated atom to an array.