CIP JAVA documentation for class "com.ptc.wfc.wfcExternalObject.SelectionBox"

Class SelectionBox

package com.ptc.wfc.wfcExternalObject; public class SelectionBox implements jxobject

Description

A 2x3 array representing a selection box

Array provides methods for accessing its elemnts by index(indices) and for modifying its elements. Array object "does not know" its dimentions.

Array Dimensions: [2] [3]

Method Summary
`static SelectionBox`	`create ()` Creates new array object with uninitialized elements.
`double`	`get (int idx0, int idx1)` Gets an array element with the specified index(indices). If an index is out of range throws exception `cipXInvalidArrayIndex`.
`void`	`set (int idx0, int idx1, double value)` Assignes a new value to an array element with the specified index(indices). If an index is out of range throws exception `cipXInvalidArrayIndex`.

Method Detail

get

double get (int idx0, int idx1)

Gets an array element with the specified index(indices). If an index is out of range throws exception cipXInvalidArrayIndex.

Parameters:

idx0: First element index.
idx1: Second element index.

Returns:: Element value.

set

void set (int idx0, int idx1, double value)

Assignes a new value to an array element with the specified index(indices). If an index is out of range throws exception cipXInvalidArrayIndex.

Parameters:

idx0: First element index.
idx1: Second element index.
value: New element value.

Returns:

create

static SelectionBox create ()

Creates new array object with uninitialized elements.

Returns:: Created array.