Namespace: GameEngine.Attributes
Class: GameEngine/Attributes/ArcGISStringCollection
Since: 2.4.0

Summary

A collection of Strings

Constructors

ArcGISStringCollection()

Creates a vector. This allocates memory that must be deleted.

Since 2.4.0

Properties

PropertyTypeNullableReadonlySummary
No
Yes

The number of values in the vector.

Size

ulong Size

The number of values in the vector.

If an error occurs, 0 will be returned.

Methods

SignatureReturn TypeSummary

Add a value to the vector.

AddArray(ArcGISCollection<string>)

Appends a vector to another vector.

Get the value at the specified position.

Determines if the vector contains the given value.

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.

Determines if there are any values in the vector.

Get the last value in the vector.

Move a value from the current position to a new position in the string vector.

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

ulong Add(string value)

Add a value to the vector.

Since 2.4.0

Arguments
NameTypeSummary
value

The value to add.

Returns ulong

The position of the value. Max value of size_t if an error occurs.

AddArray

ulong AddArray(ArcGISCollection<string> vector2)

Appends a vector to another vector.

Since 2.4.0

Arguments
NameTypeSummary
vector2
ArcGISCollection<string>

The values to add.

Returns ulong

The new size of vector_1. Max value of size_t if an error occurs.

At

string At(ulong position)

Get the value at the specified position.

Since 2.4.0

Arguments
NameTypeSummary
position

The position at which to get the value.

Returns string

The string at the specified position.

Contains

bool Contains(string value)

Determines if the vector contains the given value.

Since 2.4.0

Arguments
NameTypeSummary
value

The value to find.

Returns bool

True if the value is in the vector, otherwise false.

First

string First()

Get the first value in the vector.

Since 2.4.0

Returns string

The string at the specified position.

IndexOf

ulong IndexOf(string value)

Retrieves the position of the given value in the vector.

Since 2.4.0

Arguments
NameTypeSummary
value

The value to find.

Returns ulong

The position of the value in the vector, Max value of size_t otherwise.

Insert

void Insert(ulong position, string value)

Insert a value at the specified position in the vector.

Since 2.4.0

Arguments
NameTypeSummary
position

The position at which to insert the value.

value

The value to add.

Returns void

IsEmpty

bool IsEmpty()

Determines if there are any values in the vector.

Since 2.4.0

Returns bool

True if the vector object contains no values, otherwise false. Returns true if an error occurs.

Last

string Last()

Get the last value in the vector.

Since 2.4.0

Returns string

The String at the specified position.

Move

void Move(ulong oldPosition, ulong newPosition)

Move a value from the current position to a new position in the string vector.

Since 2.4.0

Arguments
NameTypeSummary
oldPosition

The current position of the value.

newPosition

The position to which to move the value.

Returns void

Npos

static ulong Npos()

Returns a value indicating a bad position within the vector.

Since 2.4.0

Returns ulong

A size_t.

Remove

void Remove(ulong position)

Remove a value at a specific position in the vector.

Since 2.4.0

Arguments
NameTypeSummary
position

The position where to remove the value.

Returns void

RemoveAll

void RemoveAll()

Remove all values from the vector.

Since 2.4.0

Returns void