MTOAnalysisRange#

class ansys.stk.core.stkobjects.MTOAnalysisRange#

MTO Range Computation.

Overview#

is_any_track_in_range

Return true if any track is in range of the specified object.

are_all_tracks_in_range

Return true if all tracks are in range of the specified object.

is_track_in_range

Return true is the track id is within range.

compute_ranges

Return an array of track ids with a bool value if it’s in range of the object.

compute_all_ranges

Compute the range of all track ids. Returns an array of track ids with a bool value if it’s in range of the object.

are_tracks_in_range

Return true if any track in the array is visible to the object.

lower_limit

Get or set the lower range limit in Distance Units.

upper_limit

Get or set the upper range limit in Distance Units.

object_interval

Use Extended to use the last point of the ephemeris span of the object for times past the last point. Default is Normal.

object_data

If the Object to which range will be computed is an MTO, use this option to specify the track that will be used to compute that range. By default the MTO’s ComputeTrack will be used.

object_path

Get or set the object to which range is being computed.

entirety

Range Entirety.

Import detail#

from ansys.stk.core.stkobjects import MTOAnalysisRange

Property detail#

property MTOAnalysisRange.lower_limit: float#

Get or set the lower range limit in Distance Units.

property MTOAnalysisRange.upper_limit: float#

Get or set the upper range limit in Distance Units.

property MTOAnalysisRange.object_interval: MTOObjectInterval#

Use Extended to use the last point of the ephemeris span of the object for times past the last point. Default is Normal.

property MTOAnalysisRange.object_data: int#

If the Object to which range will be computed is an MTO, use this option to specify the track that will be used to compute that range. By default the MTO’s ComputeTrack will be used.

property MTOAnalysisRange.object_path: str#

Get or set the object to which range is being computed.

property MTOAnalysisRange.entirety: MTOEntirety#

Range Entirety.

Method detail#

MTOAnalysisRange.is_any_track_in_range(self, time: Any) bool#

Return true if any track is in range of the specified object.

Parameters:

time : Any

Returns:

bool

MTOAnalysisRange.are_all_tracks_in_range(self, time: Any) bool#

Return true if all tracks are in range of the specified object.

Parameters:

time : Any

Returns:

bool

MTOAnalysisRange.is_track_in_range(self, track_id: int, time: Any) bool#

Return true is the track id is within range.

Parameters:

track_id : int

time : Any

Returns:

bool

MTOAnalysisRange.compute_ranges(self, mode: MTORangeMode, track_ids: list, time: Any) list#

Return an array of track ids with a bool value if it’s in range of the object.

Parameters:

mode : MTORangeMode

track_ids : list

time : Any

Returns:

list

MTOAnalysisRange.compute_all_ranges(self, mode: MTORangeMode, time: Any) list#

Compute the range of all track ids. Returns an array of track ids with a bool value if it’s in range of the object.

Parameters:

mode : MTORangeMode

time : Any

Returns:

list

MTOAnalysisRange.are_tracks_in_range(self, all_or_any: MTOTrackEvaluationType, track_ids: list, time: Any) bool#

Return true if any track in the array is visible to the object.

Parameters:

all_or_any : MTOTrackEvaluationType

track_ids : list

time : Any

Returns:

bool