BasicManeuverStrategyRelativeCourse#

class ansys.stk.core.stkobjects.aviator.BasicManeuverStrategyRelativeCourse#

Bases: IBasicManeuverStrategy

Class defining the Relative Course strategy for a basic maneuver procedure.

Overview#

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 Relative Course.

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.

use_relative_course

Get or set the option to specify a relative course as opposed to a true course.

course

Get or set the course value.

in_track

Get or set the in track offset from the center of the target.

cross_track

Get or set the cross track offset from the center of the target.

maneuver_factor

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

use_approach_turn_mode

Get or set the option to fly the base leg of the maneuver with a constant radius turn.

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.

closure_mode

Get or set the closure mode for the guidance strategy.

downrange_offset

Get or set the downrange offset for the closure options.

hobs_max_angle

Get or set the closure high off boresight max angle.

hobs_angle_tol

Get or set the closure high off boresight angle tolerance.

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 Relative Course.

Import detail#

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

Property detail#

property BasicManeuverStrategyRelativeCourse.target_name: str#

Get or set the target name.

property BasicManeuverStrategyRelativeCourse.valid_target_names: list#

Return the valid target names.

property BasicManeuverStrategyRelativeCourse.target_resolution: float#

Get or set the target position/velocity sampling resolution.

property BasicManeuverStrategyRelativeCourse.use_relative_course: bool#

Get or set the option to specify a relative course as opposed to a true course.

property BasicManeuverStrategyRelativeCourse.course: Any#

Get or set the course value.

property BasicManeuverStrategyRelativeCourse.in_track: float#

Get or set the in track offset from the center of the target.

property BasicManeuverStrategyRelativeCourse.cross_track: float#

Get or set the cross track offset from the center of the target.

property BasicManeuverStrategyRelativeCourse.maneuver_factor: float#

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

property BasicManeuverStrategyRelativeCourse.use_approach_turn_mode: bool#

Get or set the option to fly the base leg of the maneuver with a constant radius turn.

property BasicManeuverStrategyRelativeCourse.control_limit_mode: BasicManeuverStrategyNavigationControlLimit#

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

property BasicManeuverStrategyRelativeCourse.control_limit_turn_radius: float#

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

property BasicManeuverStrategyRelativeCourse.control_limit_turn_rate: Any#

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

property BasicManeuverStrategyRelativeCourse.control_limit_horizontal_acceleration: float#

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

property BasicManeuverStrategyRelativeCourse.closure_mode: ClosureMode#

Get or set the closure mode for the guidance strategy.

property BasicManeuverStrategyRelativeCourse.downrange_offset: float#

Get or set the downrange offset for the closure options.

property BasicManeuverStrategyRelativeCourse.hobs_max_angle: Any#

Get or set the closure high off boresight max angle.

property BasicManeuverStrategyRelativeCourse.hobs_angle_tol: Any#

Get or set the closure high off boresight angle tolerance.

property BasicManeuverStrategyRelativeCourse.compensate_for_coriolis_acceleration: bool#

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

property BasicManeuverStrategyRelativeCourse.position_velocity_strategies: BasicManeuverTargetPositionVelocity#

Get the position velocity strategies for Relative Course.

Method detail#

BasicManeuverStrategyRelativeCourse.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

BasicManeuverStrategyRelativeCourse.cancel_target_position_velocity(self) None#

Cancel the position velocity strategies for Relative Course.

Returns:

None