Detailed Description
template<>
class XSI::CDataArray< bool >
This class is a specialization of a CDataArray class of type bool
.
- Since:
- 7.0
- See also:
- CDataArray2D, CIndexSet, ICENodeDef, CDataArrayBool
#include <xsi_dataarray.h>
Inherits CBaseDataArray.
List of all members.
Constructor & Destructor Documentation
Constructor for bool
array types bound to input ports.
- Parameters:
-
in_ctxt | ICENode evaluation context. |
in_nInputPortID | Input port identifier. |
in_nInstanceIndex | The group instance of the port. |
Constructor for bool
array types bound to output ports.
- Parameters:
-
Member Function Documentation
SICPPSDK_INLINE CStatus CopyFrom |
( |
ULONG |
in_nInputPortID, |
|
|
ULONG |
in_nInstanceIndex = 0 |
|
) |
| |
Copy the data from a given input port to this object buffer without allocating memory. This is typically used for passing data by reference from input to output ports, similar to what the built-in 'pass through' node is doing.
- Parameters:
-
in_nInputPortID | Input port identifier. |
in_nInstanceIndex | The group instance of the port. |
- Returns:
- CStatus::OK Success
-
CStatus::InvalidArgument Fails if in_nInputPortID is not an input port identifier or in_nInstanceIndex is invalid.
-
CStatus::AccessDenied This array is not an output type or wasn't created properly.
- Example:
SICPPSDK_INLINE const bool operator[] |
( |
ULONG |
in_nIndex | ) |
const |
Accessor to the bool
array. This operator is called when reading the data so the return value is read-only.
- Parameters:
-
in_nIndex | Index in the array. The index must be smaller than the number of elements in the array, otherwise the results are unpredicted. |
- Returns:
- A read-only value to the indexed item.
SICPPSDK_INLINE CStatus Set |
( |
ULONG |
in_nIndex, |
|
|
bool |
in_bVal |
|
) |
| |
Sets the array at a given index with a value.
- Parameters:
-
in_nIndex | Index in the array. The index must be smaller than the number of elements in the array, otherwise the results are unpredicted. |
in_bVal | Value to set. |
- Returns:
- CStatus::OK Success
SICPPSDK_INLINE ULONG GetCount |
( |
void |
| ) |
const |
Returns the number of elements in the array.
- Returns:
- Number of elements.
SICPPSDK_INLINE bool IsConstant |
( |
| ) |
const |
Returns true if the array is constant or false otherwise. A constant array has only one value.
- Returns:
- True if constant, false otherwise.
The documentation for this class was generated from the following file: