StringArray Object

Description

A StringArray is used to hold and manipulate a set of strings. The StringArray has N elements, indexed by n = 0,1,2...N-1. The number of elements in a StringArray can be set when the StringArray is created using square brackets. If the number of elements is not specified, the StringArray will have ten elements. StringArray indices are accessed using square brackets. This example shows how to create a StringArray with three elements and assign a value to the first element:

StringArray StringArray1[3];

StringArray1[0] = "Test";

You can assign StringArray objects using the = operator.

Inheritance Hierarchy: Object->StringArray

Available In Editions:

Engineer

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description	Attributes
Back	Returns the value of the last element in the StringArray. Identical to Top.	Type: String Access: Read/Write
Capacity	The amount of memory that is reserved for the StringArray in units of number of elements. The Capacity will equal the maximum Dimension that the StringArray has had, unless it is set to a different value. The capacity can never be smaller than the current StringArray Dimension.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Dimension	The number of elements (N) contained within the StringArray.	Type: Variable Access: Read/Write
Element	The values of the elements of the StringArray, where the array index (n) starts at 0 and goes up to (N-1) (where N is the Dimension of the StringArray). The number of elements in a StringArray is limited only by the memory available on the host computer.	Type: StringArray Access: Read/Write
Front	Returns the value of the first element in the StringArray.	Type: String Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Pop	Returns the value of the last element in the StringArray and then removes it, reducing the StringArray Dimension by 1. Identical to PopBack.	Type: String Access: Read-Only
PopBack	Returns the value of the last element in the StringArray and then removes it, reducing the StringArray Dimension by 1. Identical to Pop.	Type: String Access: Read-Only
PopFront	Returns the value of the first element in the StringArray and then removes it, reducing the StringArray Dimension by 1.	Type: String Access: Read-Only
Top	Returns the value of the last element in the StringArray. Identical to Back.	Type: String Access: Read/Write

Name	Description
Add	Adds the value of the specified argument to the end of the StringArray, increasing the dimension of the StringArray by one. Returns the new dimension of the StringArray.
BuildSingleString	Returns a concatenation of the elements of the StringArray, delimited by the user-specified character sequence.
ClearArray	Deletes all elements of the StringArray, changing the StringArray Dimension to Zero (0).
ClearSavedStates	Clears previous saved states for this object.
Erase	Removes the specified element from the StringArray, decreasing the dimension of the StringArray by one.
Find	Returns the position of the specified string (or character) in the calling String, or the number of matches in the calling StringArray.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetShuffledElements	Returns a copy of the calling StringArray where the elements have been randomly shuffled. Calling SeedNoise will set the seed for this method.
GetUniqueElements	Returns a StringArray containing the unique elements of the calling StringArray in the order in which they appeared in the calling StringArray.
IFind	Returns the position of the specified string (or character) in the calling String, or the number of matches in the calling StringArray, ignoring case.
Insert	Inserts a value into the calling StringArray at the specified index, increasing the dimension of the StringArray by one.
IsEqualTo	Determines if two arrays are equal.
Push	Adds the value of the specified argument to the end of the StringArray, increasing the dimension of the StringArray by one. Returns the new dimension of the StringArray.
PushBack	Adds the value of the specified argument to the end of the StringArray, increasing the dimension of the StringArray by one. Returns the new dimension of the StringArray.
PushFront	Adds the value of the specified argument to the front of the calling StringArray, increasing the dimension of the StringArray by one. Returns the new dimension of the StringArray.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReadFromFile	Reads the entire contents of a file and places each line into an individual element of a StringArray.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Reverse	Returns a string array with the elements in reverse order.
Save	Save the object's state so that it can be restored later.
Shuffle	Randomly shuffles the elements of the calling StringArray. Calling SeedNoise will set the seed for this method.
SortAscending	Sorts the elements of the array in ascending order (smallest to largest).
SortAscendingCaseInsensitive	Sorts the calling StringArray in ascending order and reorders all input StringArray and Array arguments to maintain their relative indexing with respect to the calling StringArray. This method is case-insensitive.
SortDescending	Sorts the elements of the array in descending order (largest to smallest).
SortDescendingCaseInsensitive	Sorts the calling StringArray in descending order, reordering all input StringArray and Array arguments in order to maintain the relative positions of the array elements. This method is case-insensitive.
SortedAscending	Returns a copy of the calling StringArray sorted in ascending order.
SortedDescending	Returns a copy of the calling StringArray sorted in descending order.
SplitSort	Splits each element of the calling StringArray into columns based on the delimiter specified by an input String, then sorts the columns based on the precedence specified in an input Array. If no input Array is used, the first column will be sorted, reordering the other columns to maintain the relative positions of the array elements. Then reforms each row, using spaces or a second input String to merge the columns.
ToArray	Converts the StringArray to a normal Array with Variable values.
WriteToFile	Writes the contents of a StringArray to a file. Each Element becomes a new line in the file.