CIP C++ documentation for class "pfcUDFReferences"

Class pfcUDFReferences

# include <pfcUDFCreate.h> class pfcUDFReferences : public xobject { xdeclare(pfcUDFReferences) ... }; This is a COMPACT class.

Description

This class describes a sequence of arrays of element references.

The user can access elements by their integer index (position) in the list. Sequence provides methods for positional (indexed) access to its elements. Sequences are zero based.

Method Summary


`void`	`append (optional pfcUDFReference_ptr value)`
	Appends an element with the specified value to the end of the sequence.

`void`	`clear ()`
	Removes all the elements from the sequence.

`static pfcUDFReferences *`	`create ()`
	Creates a new empty sequence.

`static pfcUDFReferences *`	`createCapacity (xint count)`
	Creates a new empty sequence with a specified initial capacity. Capacity is the number of elements, that can be added to the sequence without having to reallocate its internal buffers.

`optional pfcUDFReference_ptr`	`get (xint idx)`
	Returns the value of the sequence element with the specified index. If the index is out of range, this method throws exception `cipXInvalidSeqIndex`.

`xint`	`getarraysize ()`
	Returns current number of elements in the sequence.

`void`	`insert (xint idx, optional pfcUDFReference_ptr value)`
	Inserts an element with the specified value in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.

`void`	`insertseq (xint idx, xtbsequence<pfcUDFReference_ptr> *seq)`
	Inserts elements from the list passed as the second argument in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.

`void`	`removerange (xint frominc, xint toexcl)`
	Removes elements in the specified range from the sequence. The first argument specifies the index of the first element to be removed. The second argument specifies the index of the element immediately after the last in the range to be removed.

`void`	`set (xint idx, optional pfcUDFReference_ptr value)`
	Assigns a value to the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.

Method Detail

xint getarraysize ()

Returns current number of elements in the sequence.

Returns:: Current number of elements.

optional pfcUDFReference_ptr get (xint idx)

Returns the value of the sequence element with the specified index. If the index is out of range, this method throws exception cipXInvalidSeqIndex.

Parameters:

idx: Index of requested sequence element.

Returns:: Value of the element at the specified index.

void set (xint idx, optional pfcUDFReference_ptr value)

Assigns a value to the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.

Parameters:

idx: Index of the element to be assigned.
value: Value to be assigned.

Returns:

void removerange (xint frominc, xint toexcl)

Removes elements in the specified range from the sequence. The first argument specifies the index of the first element to be removed. The second argument specifies the index of the element immediately after the last in the range to be removed.

Parameters:

frominc: Index of the first element to be removed.
toexcl: Index of the element following the last element to be removed.

Returns:

void append (optional pfcUDFReference_ptr value)

Appends an element with the specified value to the end of the sequence.

Parameters:

value: Value to be appended.

Returns:

void insert (xint idx, optional pfcUDFReference_ptr value)

Inserts an element with the specified value in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

Parameters:

idx: Index for an element to be inserted at.
value: Value to be inserted.

Returns:

void insertseq (xint idx, xtbsequence<pfcUDFReference_ptr> *seq)

Inserts elements from the list passed as the second argument in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.

Parameters:

idx: Index at which the first new element should be inserted.
seq: Sequence of elements to be inserted.

Returns:

void clear ()

Removes all the elements from the sequence.

Returns:

static pfcUDFReferences * create ()

Creates a new empty sequence.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

Returns:: Created sequence.

static pfcUDFReferences * createCapacity (xint count)

Creates a new empty sequence with a specified initial capacity. Capacity is the number of elements, that can be added to the sequence without having to reallocate its internal buffers.

Parameters:

count

Returns:: Created sequence.