Class pfcFamilyTableRows
# include <pfcFamily.h>
class pfcFamilyTableRows
: public xobject
{
xdeclare(pfcFamilyTableRows)
...
};
This is a COMPACT class.
Description
This data type is used to specify a list of rows in a family table.
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.
Manual References:
Method Summary
void | |
Appends an element with the specified value to the end of the sequence. | |
void | clear () |
Removes all the elements from the sequence. | |
create () | |
Creates a new empty sequence. | |
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. | |
Returns the value of the sequence element with the specified index. If the index is out of range, this method throws exception cipXInvalidSeqIndex. | |
getarraysize () | |
Returns current number of elements in the sequence. | |
void | |
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 | |
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 | |
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 | |
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
getarraysize | () |
Returns current number of elements in the sequence.
Returns:
Current number of elements.
get |
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 |
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:
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 |
Appends an element with the specified value to the end of the sequence.
Parameters:
value
Value to be appended.
Returns:
void | insert |
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.
Parameters:
idx
Index for an element to be inserted at.
value
Value to be inserted.
Returns:
void | insertseq |
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:
create | () |
Creates a new empty sequence.
Returns:
Created sequence.
createCapacity |
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.