VehicleTargetPointingCollection

class ansys.stk.core.stkobjects.VehicleTargetPointingCollection

List of Attitude Targets.

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	Return true if the collection contains the specified target.
remove	Remove the element using the object path.
add_position_as_target	Add the specified LLA position to the collection of targets. Latitude param uses Latitude Dimension, Longitude param uses Longitude Dimension. Alt param uses Distance Dimension.

Properties

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

Import detail

from ansys.stk.core.stkobjects import VehicleTargetPointingCollection

Property detail

property VehicleTargetPointingCollection.count: int

Return the number of elements in a collection.

property VehicleTargetPointingCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

property VehicleTargetPointingCollection.available_targets: list

Return an array of available targets.

Method detail

VehicleTargetPointingCollection.item(self, index: int) → VehicleTargetPointingElement

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

VehicleTargetPointingElement

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

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

VehicleTargetPointingCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

VehicleTargetPointingCollection.add(self, short_path: str) → VehicleTargetPointingElement

Add a new element to the collection.

Parameters:

short_path : str

Returns:

VehicleTargetPointingElement

VehicleTargetPointingCollection.contains(self, path: str) → bool

Return true if the collection contains the specified target.

Parameters:

path : str

Returns:

bool

VehicleTargetPointingCollection.remove(self, path: str) → None

Remove the element using the object path.

Parameters:

path : str

Returns:

None

VehicleTargetPointingCollection.add_position_as_target(self, latitude: float, longitude: float, altitude: float) → VehicleTargetPointingElement

Add the specified LLA position to the collection of targets. Latitude param uses Latitude Dimension, Longitude param uses Longitude Dimension. Alt param uses Distance Dimension.

Parameters:

latitude : float

longitude : float

altitude : float

Returns:

VehicleTargetPointingElement