DG Kernel Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
Overview of the software
What is new
Licensing
Expand ModelsModels
Expand DG Kernel ComponentsDG Kernel Components
Expand API ReferenceAPI Reference
Expand Samples and TutorialsSamples and Tutorials
Expand GraphicsGraphics
Expand Math ObjectsMath Objects
Collapse DeprecatedDeprecated
Redistribution
Model Viewer
Open Source
Support
Skip Navigation LinksHome Page > Deprecated > Deprecated API Reference > General Computing > Collections > IArrayNum Search Documentation


IArrayNum Interface

Count (Get)
Count (Set)
Get
Set
InsertAt
Add
RemoveAt
RemoveAll

Gives access to an array of floating point numbers

See also Interface List


[propget] HRESULT Count(int * count)

Parameters

count - [out,retval] the returned size of the array

Remarks:

Returns size of the array. This method is a get method for Count property of the array


[propput] HRESULT Count(int count)

Parameters

count - [in] new size of the array

Remarks:

Changes size of the array. Stored numbers are preserved where possible. This method is the set method of Count property of the array


[propget] HRESULT Get(int index, double* val)

Parameters

index - [in] 0-based index into the array

val - [out,retval] The returned index-th number

Return Values

S_OK in case of success.

DISP_E_BADINDEX if the index was out of range

Remarks:

The method returns the index-th number stored in the array. This method is the get method of Val property of the array


[propput] HRESULT Set(int index, double val)

Parameters

index - [in] 0-based index into the array

val - [in] new value of the the index-th element

Return Values

S_OK in case of success.
DISP_E_BADINDEX if the index was out of range>
Remarks:

Sets the index-th number. This method is the set method of Val property of the array.


HRESULT InsertAt(int index, double val)

Parameters

index - [in] 0-based index into the array

val - [in] new value of the the index-th element

Return Values

S_OK in case of success.
DISP_E_BADINDEX if the index was out of range
Remarks:

The method inserts val at the specified index. Elements after are shifted up.


HRESULT Add(double val)

Parameters

val - [in] the number to be added

Remarks:

The method adds val at the end of the array


HRESULT RemoveAt(int index)

Parameters

index - [in] 0-based index into the array

Return Values

S_OK in case of success.
DISP_E_BADINDEX if the index was out of range
Remarks:

The method removes element at the specified index. Elements after are shifted down.


HRESULT RemoveAll()

Remarks:

The method empties the array. It is equivalent to SetCount(0).