BasicManeuverStrategyStationkeeping

class ansys.stk.core.stkobjects.aviator.BasicManeuverStrategyStationkeeping

Bases: IBasicManeuverStrategy

Class defining the Stationkeeping strategy for a basic maneuver procedure.

Overview

Methods

set_control_limit	Set the method and corresponding value to define the control limits of the aircraft during the maneuver.
cancel_target_position_velocity	Cancel the position velocity strategies for Station Keeping.

Properties

target_name	Get or set the target name.
valid_target_names	Return the valid target names.
target_resolution	Get or set the target position/velocity sampling resolution.
max_target_speed_fraction	Get or set the maximum speed relative to the target.
relative_bearing	Get or set the bearing relative to the target that the aircraft will hold.
relative_range	Get or set the range from the target where the aircraft will hold.
desired_radius	Get or set the goal radius of the holding circle.
turn_direction	Define if the aircraft turns left or right into the holding circle.
maneuver_factor	Get or set the maneuver factor, a dimensionless factor that determines how tightly or gently the aircraft will maneuver.
stop_condition	Get or set the stopping condition for the maneuver.
use_relative_course	Option to use a relative course as opposed to an absolute course.
stop_course	Get or set the course stop condition.
stop_after_turn_count	Get or set the number of turns stop condition.
stop_after_duration	Get or set the duration stop condition.
stop_after_time	Get or set the time stop condition.
control_limit_mode	Get the method to define the control limits of the aircraft during the maneuver.
control_limit_turn_radius	Get the specified turn radius for a control limit mode of specify min turn radius.
control_limit_turn_rate	Get the specified turn rate for a control limit mode of specify max turn rate.
control_limit_horizontal_acceleration	Get the specified horizontal acceleration for a control limit mode of specify max horiz accel.
compensate_for_coriolis_acceleration	Get or set the option to compensate for the acceleration due to the Coriolis effect.
position_velocity_strategies	Get the position velocity strategies for Station Keeping.

Import detail

from ansys.stk.core.stkobjects.aviator import BasicManeuverStrategyStationkeeping

Property detail

property BasicManeuverStrategyStationkeeping.target_name: str

Get or set the target name.

property BasicManeuverStrategyStationkeeping.valid_target_names: list

Return the valid target names.

property BasicManeuverStrategyStationkeeping.target_resolution: float

Get or set the target position/velocity sampling resolution.

property BasicManeuverStrategyStationkeeping.max_target_speed_fraction: float

Get or set the maximum speed relative to the target.

property BasicManeuverStrategyStationkeeping.relative_bearing: Any

Get or set the bearing relative to the target that the aircraft will hold.

property BasicManeuverStrategyStationkeeping.relative_range: float

Get or set the range from the target where the aircraft will hold.

property BasicManeuverStrategyStationkeeping.desired_radius: float

Get or set the goal radius of the holding circle.

property BasicManeuverStrategyStationkeeping.turn_direction: TurnDirection

Define if the aircraft turns left or right into the holding circle.

property BasicManeuverStrategyStationkeeping.maneuver_factor: float

Get or set the maneuver factor, a dimensionless factor that determines how tightly or gently the aircraft will maneuver.

property BasicManeuverStrategyStationkeeping.stop_condition: StationkeepingStopCondition

Get or set the stopping condition for the maneuver.

property BasicManeuverStrategyStationkeeping.use_relative_course: bool

Option to use a relative course as opposed to an absolute course.

property BasicManeuverStrategyStationkeeping.stop_course: Any

Get or set the course stop condition.

property BasicManeuverStrategyStationkeeping.stop_after_turn_count: int

Get or set the number of turns stop condition.

property BasicManeuverStrategyStationkeeping.stop_after_duration: float

Get or set the duration stop condition.

property BasicManeuverStrategyStationkeeping.stop_after_time: Any

Get or set the time stop condition.

property BasicManeuverStrategyStationkeeping.control_limit_mode: BasicManeuverStrategyNavigationControlLimit

Get the method to define the control limits of the aircraft during the maneuver.

property BasicManeuverStrategyStationkeeping.control_limit_turn_radius: float

Get the specified turn radius for a control limit mode of specify min turn radius.

property BasicManeuverStrategyStationkeeping.control_limit_turn_rate: Any

Get the specified turn rate for a control limit mode of specify max turn rate.

property BasicManeuverStrategyStationkeeping.control_limit_horizontal_acceleration: float

Get the specified horizontal acceleration for a control limit mode of specify max horiz accel.

property BasicManeuverStrategyStationkeeping.compensate_for_coriolis_acceleration: bool

Get or set the option to compensate for the acceleration due to the Coriolis effect.

property BasicManeuverStrategyStationkeeping.position_velocity_strategies: BasicManeuverTargetPositionVelocity

Get the position velocity strategies for Station Keeping.

Method detail

BasicManeuverStrategyStationkeeping.set_control_limit(self, control_limit_mode: BasicManeuverStrategyNavigationControlLimit, control_limit_value: float) → None

Set the method and corresponding value to define the control limits of the aircraft during the maneuver.

Parameters:

control_limit_mode : BasicManeuverStrategyNavigationControlLimit

control_limit_value : float

Returns:

None

BasicManeuverStrategyStationkeeping.cancel_target_position_velocity(self) → None

Cancel the position velocity strategies for Station Keeping.

Returns:

None