CHardwareAttributeArray Class Reference
 
 
 
CHardwareAttributeArray Class Reference

#include <xsi_hardwareattribute.h>


Class Description

The CHardwareAttributeArray is an uni-dimensional array of CHardwareAttribute.

The array is zero-based, which means that the first item index is 0 and the larger index is one less that the number of elements contained in the array.

See also:
CHardwareAttribute

List of all members.

Public Member Functions

  CHardwareAttributeArray (LONG in_size=0)
  CHardwareAttributeArray (const CHardwareAttributeArray &in_array)
  ~CHardwareAttributeArray ()
CHardwareAttributeArray operator= (const CHardwareAttributeArray &in_array)
LONG  GetCount () const
CStatus  Add (const CHardwareAttribute &in_item)
CStatus  Clear ()
CStatus  Resize (LONG in_size)
const CHardwareAttribute operator[] (LONG in_index) const
CHardwareAttribute operator[] (LONG in_index)
bool  operator== (const CHardwareAttributeArray &in_array) const
bool  operator!= (const CHardwareAttributeArray &in_array) const

Constructor & Destructor Documentation

CHardwareAttributeArray ( LONG  in_size = 0 )

Constructs a CHardwareAttributeArray and optionally initializes the array to a known size.

Parameters:
in_size Size of array, defaults to 0.

Constructs a CHardwareAttributeArray object from another CHardwareAttributeArray object.

Parameters:
in_array constant CHardwareAttributeArray object.

Default destructor.


Member Function Documentation

CHardwareAttributeArray& operator= ( const CHardwareAttributeArray in_array )

Assignment operator.

Parameters:
in_array constant class object.
Returns:
A reference to this array.
LONG GetCount ( ) const

Returns the number of items in this CHardwareAttributeArray

Returns:
The number of items in the array.
CStatus Add ( const CHardwareAttribute in_item )

Adds a CHardwareAttribute at the end of this array's.

Parameters:
in_item New item to be added at the end of the array.
Returns:
CStatus::OK success
CStatus Clear ( )

Erases all elements contained in the array.

Returns:
CStatus::OK success
CStatus Resize ( LONG  in_size )

Reallocates memory for the array, preserves its contents if the new size is larger than existing size.

Parameters:
in_size New size of the array.
Returns:
CStatus::OK success
CStatus::InvalidArgument in_size < 0
const CHardwareAttribute& operator[] ( LONG  in_index ) const

Accessor to elements at a given index. This function can only be called by constant objects, the returned value is read-only.

Parameters:
in_index index in this zero-based array. The index must be greater or equal to zero and smaller than the number of element in the array, otherwise the results are unpredictable.
Returns:
A read-only reference to the indexed item.
CHardwareAttribute& operator[] ( LONG  in_index )

Accessor to elements at a given index.

Parameters:
in_index index in this zero-based array. The index must be greater or equal to zero and smaller than the number of element in the array, otherwise the results are unpredictable.
Returns:
A reference to the indexed item.
bool operator== ( const CHardwareAttributeArray in_array ) const

Equality operator.

Parameters:
in_array CHardwareAttributeArray to compare with.
Returns:
true if in_array contains the same number of elements as this array and if all members of in_array are equal to the corresponding one contained in this array.
bool operator!= ( const CHardwareAttributeArray in_array ) const

Inequality

Parameters:
in_array
Returns:
true if one member of in_array is different from the corresponding members in this array or if the arrays are not of the same size.

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