CValueArray Class Reference

This reference page is linked to from the following overview topics: Bundling Several Handlers in One Library File (.DLL/SO), Working with Arguments, Calling C++ Custom Commands from Scripting, Legacy Plug-in Callbacks, Migrating Legacy Plug-ins.

---

Search for all occurrences

#include <xsi_value.h>

---

Class Description

The CValueArray is an uni-dimensional array of CValue.

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:

CValue, FCurve::SetKeys, Application::ExecuteCommand

List of all members.

Public Member Functions
	CValueArray (LONG in_size=0)
	CValueArray (const CValueArray &in_array)
	~CValueArray ()
CValueArray &	operator= (const CValueArray &in_array)
LONG	GetCount () const
CStatus	Add (const CValue &in_item)
CStatus	Clear ()
CStatus	Resize (LONG in_size)
const CValue &	operator[] (LONG in_index) const
CValue &	operator[] (LONG in_index)
bool	operator== (const CValueArray &in_array) const
bool	operator!= (const CValueArray &in_array) const

---

Constructor & Destructor Documentation

CValueArray

(

LONG

in_size = 0

)

Constructs a CValueArray and optionally initializes the array to a known size.

Parameters:

in_size

Size of array, defaults to 0.

CValueArray

(

const CValueArray &

in_array

)

Constructs a CValueArray object from another CValueArray object.

Parameters:

in_array

constant CValueArray object.

~CValueArray

(

)

Default destructor.

---

Member Function Documentation

CValueArray& operator=

(

const CValueArray &

in_array

)

Assignment operator.

Parameters:

in_array

constant class object.

Returns:

A reference to this array.

LONG GetCount

(

)

const

Search for all occurrences

Returns the number of items in this CValueArray

Returns:

The number of items in the array.

CStatus Add

(

const CValue &

in_item

)

Search for all occurrences

Adds a CValue at the end of this array's.

Parameters:

in_item

New item to be added at the end of the array.

Returns:

CStatus::OK success

CStatus Clear

(

)

Search for all occurrences

Erases all elements contained in the array.

Returns:

CStatus::OK success

CStatus Resize

(

LONG

in_size

)

Search for all occurrences

Reallocates memory for the array, preserves its contents if the 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 CValue& 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 greater or equal to zero and smaller than the number of element in the array, otherwise the results are unpredictable.

Returns:

A read-only reference to the indexed item.

CValue& operator[]

(

LONG

in_index

)

Accessor to elements at a given index.

Parameters:

in_index

index in this zero-based array. The index must be greater or equal to zero and smaller than the number of element in the array, otherwise the results are unpredictable.

Returns:

A reference to the indexed item.

bool operator==

(

const CValueArray &

in_array

)

const

Equality operator.

Parameters:

in_array

CValueArray to compare with.

Returns:

true if in_array contains the same number of elements as this array and if all members of in_array are equal to the corresponding one contained in this array.

bool operator!=

(

const CValueArray &

in_array

)

const

Inequality

Parameters:

in_array

Returns:

true if one member of in_array is different from 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:

• xsi_value.h