This class is used to represent arrays of intrinsic data types in CIM.

Documentation

This class is used to represent arrays of intrinsic data types in CIM.

Inheritance:

Public Methods

	Array () Constructs an array object with null values (default constructor)
	Array (const Array<PEGASUS_ARRAY_T>& x) Creates a new Array object using the parameters and values in the Array object.
	Array (Uint32 size) Constructs an array with size elements.
	Array (Uint32 size, const PEGASUS_ARRAY_T& x) Constructs an array with size elements.
	Array (const PEGASUS_ARRAY_T* items, Uint32 size) Constructs an array with size elements.
	~Array () Destroys the objects, freeing any resources
Array<PEGASUS_ARRAY_T> &	operator= (const Array<PEGASUS_ARRAY_T>& x) The values of one array object are assigned to another (assignment operator).
void	clear () Clears the contents of the array.
void	reserveCapacity (Uint32 capacity) Reserves memory for capacity elements.
void	grow (Uint32 size, const PEGASUS_ARRAY_T& x) Make the size of the array grow by size elements.
void	swap (Array<PEGASUS_ARRAY_T>& x) Swaps the contents of two arrays.
Uint32	size () const Returns the number of elements in the array.
Uint32	getCapacity () const Returns the capacity of the array.
const PEGASUS_ARRAY_T*	getData () const Returns a pointer to the first element of the array.
PEGASUS_ARRAY_T&	operator[] (Uint32 index) Returns the element indicated by the index argument.
const PEGASUS_ARRAY_T&	operator[] (Uint32 index) const Returns the element in the const array specified as the index argument.
void	append (const PEGASUS_ARRAY_T& x) Appends an element to the end of the array.
void	append (const PEGASUS_ARRAY_T* x, Uint32 size) Appends size elements at x to the end of this array.
void	appendArray (const Array<PEGASUS_ARRAY_T>& x) Appends one array to another.
void	prepend (const PEGASUS_ARRAY_T& x) Appends one element to the beginning of the array.
void	prepend (const PEGASUS_ARRAY_T* x, Uint32 size) Appends size elements to the array starting at the memory address given by x.
void	insert (Uint32 index, const PEGASUS_ARRAY_T& x) Inserts the element at the given index in the array.
void	insert (Uint32 index, const PEGASUS_ARRAY_T* x, Uint32 size) Inserts size elements at x into the array at the given index.
void	remove (Uint32 index) Removes the element at the given index from the array.
void	remove (Uint32 index, Uint32 size) Removes size elements starting at the given index.

Array()

Constructs an array object with null values (default constructor)

Array(const Array<PEGASUS_ARRAY_T>& x)

Creates a new Array object using the parameters and values in the Array object.

Parameters:

x - Specifies the new Array object name.

Array(Uint32 size)

Constructs an array with size elements. The elements are initialized with their copy constructor.

Parameters:

- size Defines the number of elements.

Array(Uint32 size, const PEGASUS_ARRAY_T& x)

Constructs an array with size elements. The elements are initialized with array x.

Parameters:

- size Defines the number of elements.
x - Specifies the new array object name.

Array(const PEGASUS_ARRAY_T* items, Uint32 size)

Constructs an array with size elements. The values come from the items pointer.

Parameters:

items - References the values of the specified array.
- size Uint32 representing how many elements are in the array.

~Array()

Destroys the objects, freeing any resources

Array<PEGASUS_ARRAY_T> & operator=(const Array<PEGASUS_ARRAY_T>& x)

The values of one array object are assigned to another (assignment operator).

Parameters:

x - Array object to assign the Array parameters to.

void clear()

Clears the contents of the array. After calling this, size() returns zero.

void reserveCapacity(Uint32 capacity)

Reserves memory for capacity elements. Notice that this does not change the size of the array (size() returns what it did before). If the capacity of the array is already greater or equal to the capacity argument, this method has no effect. After calling reserveCapacity(), getCapacity() returns a value which is greater or equal to the capacity argument.

Parameters:

capacity - Defines the size that is to be reserved

void grow(Uint32 size, const PEGASUS_ARRAY_T& x)

Make the size of the array grow by size elements. The new size will be size() + size. The new elements (there are size of them) are initialized with x.

Parameters:

- size Defines the number of elements by which the array is to grow.

void swap(Array<PEGASUS_ARRAY_T>& x)

Swaps the contents of two arrays. Array x references the original values in the Array object (y) and the values of the Array object (y) reference the original values of Array x.

Uint32 size() const

Returns the number of elements in the array.

Returns:

The number of elements in the array.

Uint32 getCapacity() const

Returns the capacity of the array.

Returns:

The capacity of the array.

const PEGASUS_ARRAY_T* getData() const

Returns a pointer to the first element of the array.

Returns:

A pointer to the first element of the array.

PEGASUS_ARRAY_T& operator[](Uint32 index)

Returns the element indicated by the index argument.

Returns:

A reference to the element defined by index so that it may be modified.

const PEGASUS_ARRAY_T& operator[](Uint32 index) const

Returns the element in the const array specified as the index argument. The return value cannot be modified since it is constant.

Returns:

A reference to the element defined by index but the reference cannot be modified.

void append(const PEGASUS_ARRAY_T& x)

Appends an element to the end of the array. This increases the size of the array by one.

Parameters:

x - Element to append.

void append(const PEGASUS_ARRAY_T* x, Uint32 size)

Appends size elements at x to the end of this array.

Parameters:

- size Uint32 value to append to the size of the array.

void appendArray(const Array<PEGASUS_ARRAY_T>& x)

Appends one array to another. The size of this array grows by the size of the other.

Parameters:

x - Array to add to the appended array.

void prepend(const PEGASUS_ARRAY_T& x)

Appends one element to the beginning of the array. This increases the size by one.

Parameters:

x - The element to pre pend.

void prepend(const PEGASUS_ARRAY_T* x, Uint32 size)

Appends size elements to the array starting at the memory address given by x. The array grows by size elements.

Parameters:

- size Uint32 size to add to the array at address x.
x - Specifies where to begin increasing size elements of the array.

void insert(Uint32 index, const PEGASUS_ARRAY_T& x)

Inserts the element at the given index in the array. Subsequent elements are moved down. The size of the array grows by one.

Parameters:

x - Specifies the element to add to the array.

void insert(Uint32 index, const PEGASUS_ARRAY_T* x, Uint32 size)

Inserts size elements at x into the array at the given index. Subsequent elements are moved down. The size of the array grows by size elements.

Parameters:

x - Specifies where to begin adding elements in the array.
- size Uint32 size to add to the array starting at element x.

void remove(Uint32 index)

Removes the element at the given index from the array. The size of the array shrinks by one.

Parameters:

index - Specifies the array element to remove.

void remove(Uint32 index, Uint32 size)

Removes size elements starting at the given index. The size of the array shrinks by size elements.

Parameters:

index - Specifies where in the array to begin removing elements.
- size Uint32 size that specifies how many elements to remove from the array.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java