Detailed Description
This class is a specialization of CICEAttributeDataArray2D which allows access to the ICEAttribute data as a 2D array of type siICENodeDataString. CICEAttributeDataArray2DString objects are read-only and can be filled with the methods supplied with the ICEAttribute class.
- Note:
- Data of type siICENodeDataString can be created with custom ICENodes.
- See also:
- ICEAttribute::GetDataArray2D, ICEAttribute::GetDataArray2DChunk, CICEAttributeDataArrayString, Type Definitions for CICEAttributeDataArray
- Since:
- 9.0 (2011)
- Example:
- This example demonstrates how to iterate over the siICENodeDataString 2D attributes on a geometry. For a more detailed example, check out the ICEAttribute/netview_ICEAttribute Inspect ICE Attributes example.
#include <xsi_iceattributedataarray2D.h>
List of all members.
Constructor & Destructor Documentation
Member Function Documentation
Returns the sub-array containing the string data at a given index.
- Parameters:
-
in_index | Index in the array. The index must be smaller than the number of elements in the array, otherwise the result is unpredictable. |
- Return values:
-
- Returns:
- CStatus::OK Success
-
CStatus::InvalidArgument If
in_index
or out_dataArray
is invalid.
Changes the size of the sub-array at a given index and returns a new array pointing to the resized sub-array. This is only supported for writable attributes and not available for built-in attributes.
- Parameters:
-
in_index | Index in the array. The index must be smaller than the number of elements in the array, otherwise the result is unpredictable. |
out_dataArray | A reference to a CICEAttributeDataArray<T> object at a specific index. |
in_ulSize | The size of the array. |
- Returns:
- CStatus::OK Success
-
CStatus::InvalidArgument If
in_index
or out_dataArray
is invalid.
The documentation for this class was generated from the following file: