MTOTrackCollection#

class ansys.stk.core.stkobjects.MTOTrackCollection#

MTO Track List.

Overview#

item

Given an index, returns an element in the collection.

remove_at

Remove an element from the collection using a specified index.

remove_all

Remove all elements from the collection.

add

Add a new element to the collection.

add_track

Add a new track with the specified point data.

load_command_file

Load Track Command File.

get_track_from_identifier

Given a track id, returns an element in the collection.

remove

Remove an element from the collection using a specified track.

remove_by_identifier

Remove an element from the collection using a specified id.

add_tracks

Add and returns the desired number of new tracks starting with the desired id.

remove_tracks

Remove the provided tracks.

remove_tracks_by_identifier

Remove tracks based on the provided Ids.

add_tracks_with_position_data

Add new track with the specified position data.

extend_tracks_with_position_data

Extend tracks with the specified position data.

set_input_data_vector_geometry_tool_system_name

Set VGT Data System to MTO tracks.

clear_input_data_system

Remove VGT Data System from MTO tracks.

count

Return the number of elements in a collection.

_new_enum

Return an enumerator that can iterate through the collection.

recycling

Recycling is used for optimizing performance in iterative modification or addition of elements in a particular collection (see Remarks section for this property).

Import detail#

from ansys.stk.core.stkobjects import MTOTrackCollection

Property detail#

property MTOTrackCollection.count: int#

Return the number of elements in a collection.

property MTOTrackCollection._new_enum: EnumeratorProxy#

Return an enumerator that can iterate through the collection.

property MTOTrackCollection.recycling: bool#

Recycling is used for optimizing performance in iterative modification or addition of elements in a particular collection (see Remarks section for this property).

Method detail#

MTOTrackCollection.item(self, index: int) MTOTrack#

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

MTOTrack

MTOTrackCollection.remove_at(self, index: int) None#

Remove an element from the collection using a specified index.

Parameters:

index : int

Returns:

None

MTOTrackCollection.remove_all(self) None#

Remove all elements from the collection.

Returns:

None

MTOTrackCollection.add(self, track_id: int) MTOTrack#

Add a new element to the collection.

Parameters:

track_id : int

Returns:

MTOTrack

MTOTrackCollection.add_track(self, track_id: int, time_vals: list, lat_vals: list, lon_vals: list, alt_vals: list) MTOTrack#

Add a new track with the specified point data.

Parameters:

track_id : int

time_vals : list

lat_vals : list

lon_vals : list

alt_vals : list

Returns:

MTOTrack

MTOTrackCollection.load_command_file(self, command_file: str) None#

Load Track Command File.

Parameters:

command_file : str

Returns:

None

MTOTrackCollection.get_track_from_identifier(self, track_id: int) MTOTrack#

Given a track id, returns an element in the collection.

Parameters:

track_id : int

Returns:

MTOTrack

MTOTrackCollection.remove(self, track: MTOTrack) None#

Remove an element from the collection using a specified track.

Parameters:

track : MTOTrack

Returns:

None

MTOTrackCollection.remove_by_identifier(self, track_id: int) None#

Remove an element from the collection using a specified id.

Parameters:

track_id : int

Returns:

None

MTOTrackCollection.add_tracks(self, starting_track_id: int, numberof_tracks: int) list#

Add and returns the desired number of new tracks starting with the desired id.

Parameters:

starting_track_id : int

numberof_tracks : int

Returns:

list

MTOTrackCollection.remove_tracks(self, tracks: list) None#

Remove the provided tracks.

Parameters:

tracks : list

Returns:

None

MTOTrackCollection.remove_tracks_by_identifier(self, track_ids: list) None#

Remove tracks based on the provided Ids.

Parameters:

track_ids : list

Returns:

None

MTOTrackCollection.add_tracks_with_position_data(self, track_ids_array: list, num_pts_per_track_array: list, datatype: MTOInputDataType, times_array: list, x_or_lats_array: list, y_or_lons_array: list, z_or_alts_array: list) None#

Add new track with the specified position data.

Parameters:

track_ids_array : list

num_pts_per_track_array : list

datatype : MTOInputDataType

times_array : list

x_or_lats_array : list

y_or_lons_array : list

z_or_alts_array : list

Returns:

None

MTOTrackCollection.extend_tracks_with_position_data(self, track_ids_array: list, num_pts_per_track_array: list, datatype: MTOInputDataType, times_array: list, x_or_lats_array: list, y_or_lons_array: list, z_or_alts_array: list) None#

Extend tracks with the specified position data.

Parameters:

track_ids_array : list

num_pts_per_track_array : list

datatype : MTOInputDataType

times_array : list

x_or_lats_array : list

y_or_lons_array : list

z_or_alts_array : list

Returns:

None

MTOTrackCollection.set_input_data_vector_geometry_tool_system_name(self, command_system: str) None#

Set VGT Data System to MTO tracks.

Parameters:

command_system : str

Returns:

None

MTOTrackCollection.clear_input_data_system(self) None#

Remove VGT Data System from MTO tracks.

Returns:

None