Namespace: Esri::GameEngine::Attributes
Class: Esri/GameEngine/Attributes/ArcGISUint32Collection
Since: 2.4.0
Summary
Defines a collection of uint32 values
Constructors
ArcGISUint32Collection()
Creates a vector. This allocates memory that must be deleted.
Since 2.4.0
Properties
Size
size_t GetSize() const
The number of values in the vector.
If an error occurs, 0 will be returned.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Add a value to the vector. | ||
Appends a vector to a vector. | ||
Gets the value at the specified position. | ||
Determines if the vector contains the given value. | ||
Determines if two vectors are equal. | ||
First() | Get the first value in the vector. | |
Retrieves the position of the given value in the vector. | ||
Insert a value at the specified position in the vector. | ||
IsEmpty() | Determines if the vector contains values. | |
Last() | Get the last value in the vector. | |
Move a value from the current position to a new position in the vector. | ||
Npos() | Returns a value indicating a bad position within the vector. | |
Remove a value at a specific position in the vector. | ||
Remove all values from the vector. |
Add
Add a value to the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
value | uint32_t | Yes | The value to add. |
Returns size_t
The position of the value. Max value of size_t if an error occurs.
AddArray
Appends a vector to a vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
vector2 | ArcGISCollection<uint32_t> | Yes | The value to add. |
Returns size_t
The new size of vector_1. Max value of size_t if an error occurs.
At
Gets the value at the specified position.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
position | size_t | No | The position at which to get the value. |
Returns uint32_t
The uint32 at the specified position.
Contains
Determines if the vector contains the given value.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
value | uint32_t | Yes | The value to find. |
Returns bool
True if the value is in the vector, otherwise false.
Equals
Determines if two vectors are equal.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
vector2 | ArcGISCollection<uint32_t> | Yes | The second vector. |
Returns bool
Returns true if the two vectors are equal, false otherwise.
First
uint32_t First() const
Get the first value in the vector.
Since 2.4.0
Returns uint32_t
The uint32 at the position requested.
IndexOf
Retrieves the position of the given value in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
value | uint32_t | Yes | The value to find. |
Returns size_t
The position of the value in the vector, Max value of size_t otherwise.
Insert
Insert a value at the specified position in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
position | size_t | No | The position which you want to insert the value. |
value | uint32_t | Yes | The value that is to be added. |
Returns void
IsEmpty
bool IsEmpty() const
Determines if the vector contains values.
Since 2.4.0
Returns bool
True if the vector object contains no values, otherwise false. Returns true if an error occurs.
Last
uint32_t Last() const
Get the last value in the vector.
Since 2.4.0
Returns uint32_t
The uint32 at the specified position.
Move
Move a value from the current position to a new position in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
old | size_t | No | The current position of the value. |
new | size_t | No | The position which you want to move the value to. |
Returns void
Npos
static size_t Npos()
Returns a value indicating a bad position within the vector.
Since 2.4.0
Returns size_t
A size_t.
Remove
Remove a value at a specific position in the vector.
Since 2.4.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
position | size_t | No | The position which you want to remove the value. |