AttributeData Class Reference

AttributeData is used to store data for attributes. More...

List of all members.

Public Member Functions

AttributeDataClone () const
 Clones the object and returns a AttributeData*. (OWN).
simba_int16 GetInt16Value () const
 Returns an ATTR_UINT16 value as simba_int16, otherwise throws an exception.
simba_int32 GetInt32Value () const
 Returns an ATTR_UINT32 value as simba_int32, otherwise throws an exception.
simba_signed_native GetIntNativeValue () const
 Returns an ATTR_INT_NATIVE value as simba_signed_native, otherwise throws an exception.
simba_handle GetPointerValue () const
 Returns an ATTR_POINTER value as a simba_handle, otherwise throws an exception. (NOT OWN).
AttributeType GetType () const
 Returns the attribute data type.
simba_uint16 GetUInt16Value () const
 Returns an ATTR_UINT16 value as simba_uint16, otherwise throws an exception.
simba_uint32 GetUInt32Value () const
 Returns an ATTR_UINT32 value as simba_uint32, otherwise throws an exception.
simba_unsigned_native GetUIntNativeValue () const
 Returns an ATTR_UINT_NATIVE value as simba_unsigned_native, otherwise throws an exception.
const simba_wstringGetWStringValue () const
 Returns an ATTR_WSTRING value as a simba_wstring*, otherwise throws an exception. (NOT OWN).
bool operator!= (const AttributeData &in_other) const
 Inequality operator.
bool operator< (const AttributeData &in_other) const
 Less-than operator.
bool operator== (const AttributeData &in_other) const
 Equality operator.
 ~AttributeData ()
 Destructor.

Static Public Member Functions

static AttributeDataMakeNewAttributeDataFromSimbaByte (AttributeType in_attrDataType, const simba_byte *in_buffer)
 Static factory methods for generating new AttributeData objects.
static AttributeDataMakeNewInt16AttributeData (simba_int16 in_value)
 Generates a new AttributeData with a simba_int16 value.
static AttributeDataMakeNewInt32AttributeData (simba_int32 in_value)
 Generates a new AttributeData with a simba_int32 value.
static AttributeDataMakeNewIntNativeAttributeData (simba_signed_native in_value)
 Generates a new AttributeData with a simba_signed_native value.
static AttributeDataMakeNewPointerAttributeData (simba_handle in_value)
 Generates a new AttributeData with a pointer value.
static AttributeDataMakeNewUInt16AttributeData (simba_uint16 in_value)
 Generates a new AttributeData with a simba_uint16 value.
static AttributeDataMakeNewUInt32AttributeData (simba_uint32 in_value)
 Generates a new AttributeData with a simba_uint32 value.
static AttributeDataMakeNewUIntNativeAttributeData (simba_unsigned_native in_value)
 Generates a new AttributeData with a simba_unsigned_native value.
static AttributeDataMakeNewWStringAttributeData (simba_wstring *in_value)
 Generates a new AttributeData with a simba_wstring* value.
static AttributeDataMakeNewWStringAttributeData (const simba_wstring &in_value)
 Generates a new AttributeData with a simba_wstring value.

Detailed Description

AttributeData is used to store data for attributes.


Constructor & Destructor Documentation

~AttributeData (  ) 

Destructor.


Member Function Documentation

AttributeData* Clone (  )  const

Clones the object and returns a AttributeData*. (OWN).

simba_int16 GetInt16Value (  )  const

Returns an ATTR_UINT16 value as simba_int16, otherwise throws an exception.

simba_int32 GetInt32Value (  )  const

Returns an ATTR_UINT32 value as simba_int32, otherwise throws an exception.

simba_signed_native GetIntNativeValue (  )  const

Returns an ATTR_INT_NATIVE value as simba_signed_native, otherwise throws an exception.

simba_handle GetPointerValue (  )  const

Returns an ATTR_POINTER value as a simba_handle, otherwise throws an exception. (NOT OWN).

AttributeType GetType (  )  const

Returns the attribute data type.

simba_uint16 GetUInt16Value (  )  const

Returns an ATTR_UINT16 value as simba_uint16, otherwise throws an exception.

simba_uint32 GetUInt32Value (  )  const

Returns an ATTR_UINT32 value as simba_uint32, otherwise throws an exception.

simba_unsigned_native GetUIntNativeValue (  )  const

Returns an ATTR_UINT_NATIVE value as simba_unsigned_native, otherwise throws an exception.

const simba_wstring* GetWStringValue (  )  const

Returns an ATTR_WSTRING value as a simba_wstring*, otherwise throws an exception. (NOT OWN).

static AttributeData* MakeNewAttributeDataFromSimbaByte ( AttributeType  in_attrDataType,
const simba_byte in_buffer 
) [static]

Static factory methods for generating new AttributeData objects.

These are provided because in some cases, like the various pointers and native integer types on a 32-bit platform, the C++ data type doesn't correspond 1:1 with the attribute data type. Makes an AttributeData based on a simba_byte*

Parameters:
in_attrDataType Type of attribute data in in_buffer
in_buffer Buffer from which data that will be extracted to create the attribute data. (NOT OWN)
Returns:
AttributeData built based on content of buffer. (OWN)
static AttributeData* MakeNewInt16AttributeData ( simba_int16  in_value  )  [static]

Generates a new AttributeData with a simba_int16 value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewInt32AttributeData ( simba_int32  in_value  )  [static]

Generates a new AttributeData with a simba_int32 value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewIntNativeAttributeData ( simba_signed_native  in_value  )  [static]

Generates a new AttributeData with a simba_signed_native value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewPointerAttributeData ( simba_handle  in_value  )  [static]

Generates a new AttributeData with a pointer value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewUInt16AttributeData ( simba_uint16  in_value  )  [static]

Generates a new AttributeData with a simba_uint16 value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewUInt32AttributeData ( simba_uint32  in_value  )  [static]

Generates a new AttributeData with a simba_uint32 value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewUIntNativeAttributeData ( simba_unsigned_native  in_value  )  [static]

Generates a new AttributeData with a simba_unsigned_native value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewWStringAttributeData ( simba_wstring in_value  )  [static]

Generates a new AttributeData with a simba_wstring* value.

Parameters:
in_value The value to use to create the AttributeData. (OWN)
Returns:
The newly created AttributeData. (OWN)
static AttributeData* MakeNewWStringAttributeData ( const simba_wstring in_value  )  [static]

Generates a new AttributeData with a simba_wstring value.

Parameters:
in_value The value to use to create the AttributeData.
Returns:
The newly created AttributeData. (OWN)
bool operator!= ( const AttributeData in_other  )  const

Inequality operator.

Parameters:
in_other The AttributeData to compare this one to.
Returns:
Whether this object is not equal to in_other.
bool operator< ( const AttributeData in_other  )  const

Less-than operator.

Parameters:
in_other The AttributeData to compare this one to.
Returns:
Whether this object less than in_other.
bool operator== ( const AttributeData in_other  )  const

Equality operator.

Parameters:
in_other The AttributeData to compare this one to.
Returns:
Whether this object is equal to in_other.

Member Data Documentation


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

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba