Detailed Description
CDataArray2DCustomType is used for storing binary data in a 2D element array of type CDataArray2DCustomType::TData.
- Since:
- 8.0 (2010)
- See also:
- CDataArrayCustomType, CIndexSet
#include <xsi_dataarray2D.h>
Inherits CBaseDataArray2D.
List of all members.
Constructor & Destructor Documentation
Constructor for data 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 data 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:
Returns an accessor at a given index. This operator is called when reading the data so the return value is read-only.
- Parameters:
-
in_nArrayIndex | Index in the array. The index must be smaller than the number of elements in the array, otherwise the results are unpredicted. |
- Returns:
- Accessor object.
Changes the size of the sub-array at a given position and returns an accessor pointing to the resized sub-array.
- Parameters:
-
in_nArrayIndex | Index in the array. The index must be smaller than the number of elements in the array, otherwise the results are unpredicted. |
in_nSize | The size in bytes of the new array. |
- Returns:
- Accessor object.
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: