#include <xsi_boolarray.h>
Class Description
The CBoolArray
is an uni-dimensional array of bool values.
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:
- CEdgeRefArray::GetIsHardArray
List of all
members.
Constructor & Destructor Documentation
Constructs a CBoolArray
and optionally initializes the array to a known size.
- Parameters:
-
| in_size |
Size of array, defaults to 0. |
Member Function Documentation
Assignment operator.
- Parameters:
-
| in_array |
constant class object. |
- Returns:
- A reference to this array.
Returns the number of items in this CBoolArray
- Returns:
- The number of items in the array.
| CStatus Add |
( |
const bool & |
in_item |
) |
|
Adds a bool to the end of this array.
- Parameters:
-
| in_item |
New item to be added at the end of the array. |
- Returns:
-
CStatus::OK success
Erases all elements contained in the array.
- Returns:
-
CStatus::OK success
Reallocates memory for the array, preserves its contents if new
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 bool& 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 smaller than
the number of elements in the array, otherwise the results are
unpredicted. |
- Returns:
- A read-only reference to the indexed item.
| bool& operator[] |
( |
LONG |
in_index |
) |
|
Accessor to elements at a given index.
- Parameters:
-
| in_index |
Index in this zero based array. The index must be smaller than
the number of elements in the array, otherwise the results are
unpredicted. |
- Returns:
- A reference to the indexed item.
| bool operator== |
( |
const CBoolArray & |
in_array |
) |
const |
Equality operator.
- Parameters:
-
- Returns:
- True if
in_array contains the same number of
elements as this array and that all members of
in_array are equal to the corresponding one contained
in this array.
| bool operator!= |
( |
const CBoolArray & |
in_array |
) |
const |
Inequality operator.
- Parameters:
-
- Returns:
- True if one member of
in_array is different of 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:
