XSI::CDataArray< bool >

CDataArray< bool > Class Template Reference

This class is a specialization of a CDataArray class of type bool. More...

#include <xsi_dataarray.h>

List of all members.

Public Member Functions
SICPPSDK_INLINE  CDataArray (ICENodeContext &in_ctxt, ULONG in_nInputPortID, ULONG in_nInstanceIndex=0)
SICPPSDK_INLINE  CDataArray (ICENodeContext &in_ctxt)
SICPPSDK_INLINE  ~CDataArray ()
SICPPSDK_INLINE const bool  operator[] (ULONG in_index) const
SICPPSDK_INLINE CStatus  Set (ULONG in_index, bool in_bVal)
SICPPSDK_INLINE ULONG  GetCount () const
SICPPSDK_INLINE bool  IsConstant () const

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

Constructor & Destructor Documentation

SICPPSDK_INLINE CDataArray ( ICENodeContext &  in_ctxt,
ULONG  in_nInputPortID,
ULONG  in_nInstanceIndex = 0  
)

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.

SICPPSDK_INLINE CDataArray ( ICENodeContext &  in_ctxt  ) 

Constructor for bool array types bound to output ports.

Parameters:
in_ctxt  ICENode evaluation context.

SICPPSDK_INLINE ~CDataArray (  ) 

Destructor.

Member Function Documentation

SICPPSDK_INLINE const bool operator[] ( ULONG  in_index  )  const

Accessor to the bool array. This operator is called when reading the data so the return value is read-only.

Parameters:
in_index  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_index,
bool  in_bVal  
)

Sets the array at a given index with a value.

Parameters:
in_index  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 (  )  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: