VehicleWaypointsCollection

class ansys.stk.core.stkobjects.VehicleWaypointsCollection

Collection of waypoints for a Great Arc vehicle.

Overview

Methods

item	Given an index, returns an element in the collection.
remove_at	Remove an element from the collection using specified index.
remove_all	Remove all elements from the collection.
add	Add a new element to the collection.
contains	Determine whether the collection contains the waypoint at the specified time.
index_of	Determine whether the collection contains the specified waypoint and returns an index of existing waypoint. The index < 0 indicates the way point is not in the collection.
to_array	Return a two-dimensional array that contains the way points. Each sub-array represents a waypoint. The order of the elements is Time, Latitude, Longitude, Altitude,Speed,Acceleration,TurnRadius.

Properties

count	Return the number of elements in a collection.
_new_enum	Return an enumerator that can iterate through the collection.

Import detail

from ansys.stk.core.stkobjects import VehicleWaypointsCollection

Property detail

property VehicleWaypointsCollection.count: int

Return the number of elements in a collection.

property VehicleWaypointsCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

Method detail

VehicleWaypointsCollection.item(self, index: int) → VehicleWaypointsElement

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

VehicleWaypointsElement

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

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

VehicleWaypointsCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

VehicleWaypointsCollection.add(self) → VehicleWaypointsElement

Add a new element to the collection.

Returns:

VehicleWaypointsElement

VehicleWaypointsCollection.contains(self, time: Any) → bool

Determine whether the collection contains the waypoint at the specified time.

Parameters:

time : Any

Returns:

bool

VehicleWaypointsCollection.index_of(self, time: Any) → int

Determine whether the collection contains the specified waypoint and returns an index of existing waypoint. The index < 0 indicates the way point is not in the collection.

Parameters:

time : Any

Returns:

int

VehicleWaypointsCollection.to_array(self) → list

Return a two-dimensional array that contains the way points. Each sub-array represents a waypoint. The order of the elements is Time, Latitude, Longitude, Altitude,Speed,Acceleration,TurnRadius.

Returns:

list