MTOTrackPointCollection

class ansys.stk.core.stkobjects.MTOTrackPointCollection

MTO track point list.

Overview

Methods

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. Time uses DateFormat Dimension.
add_point	Add a new element to the collection using specified point data. Time uses DateFormat Dimension. Latitude/Longitude use Angle Dimension. Altitude uses Distance Dimension.
load_points	Load MTO track points.
extend	Extend the track with the specified point data.
insert_point	Insert a point into the track point collection. Uses the time to determine where the point should be inserted. This is slower than AddPoint, AddPoints or Extend.

Properties

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 MTOTrackPointCollection

Property detail

property MTOTrackPointCollection.count: int

Return the number of elements in a collection.

property MTOTrackPointCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

property MTOTrackPointCollection.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

MTOTrackPointCollection.item(self, index: int) → MTOTrackPoint

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

MTOTrackPoint

MTOTrackPointCollection.remove_at(self, index: int) → None

Remove an element from the collection using a specified index.

Parameters:

index : int

Returns:

None

MTOTrackPointCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

MTOTrackPointCollection.add(self, time: Any) → MTOTrackPoint

Add a new element to the collection. Time uses DateFormat Dimension.

Parameters:

time : Any

Returns:

MTOTrackPoint

MTOTrackPointCollection.add_point(self, time: Any, latitude: float, longitude: float, altitude: float) → MTOTrackPoint

Add a new element to the collection using specified point data. Time uses DateFormat Dimension. Latitude/Longitude use Angle Dimension. Altitude uses Distance Dimension.

Parameters:

time : Any

latitude : float

longitude : float

altitude : float

Returns:

MTOTrackPoint

MTOTrackPointCollection.load_points(self, mto_track_points: str) → None

Load MTO track points.

Parameters:

mto_track_points : str

Returns:

None

MTOTrackPointCollection.extend(self, time_vals: list, lat_vals: list, lon_vals: list, alt_vals: list) → None

Extend the track with the specified point data.

Parameters:

time_vals : list

lat_vals : list

lon_vals : list

alt_vals : list

Returns:

None

MTOTrackPointCollection.insert_point(self, time: Any, latitude: float, longitude: float, altitude: float) → None

Insert a point into the track point collection. Uses the time to determine where the point should be inserted. This is slower than AddPoint, AddPoints or Extend.

Parameters:

time : Any

latitude : float

longitude : float

altitude : float

Returns:

None