IGreatArcVehicle#

class ansys.stk.core.stkobjects.IGreatArcVehicle#

A base interface for all Great Arc Vehicles.

Overview#

is_attitude_type_supported

Get a value indicating whether the specified type can be used.

is_route_type_supported

Get a value indicating whether the specified type can be used.

set_attitude_type

Set the type of attitude profile.

set_route_type

Set the propagator type.

access_constraints

Get the constraints imposed on the vehicle.

attitude

Get the attitude profile.

attitude_supported_types

Return an array of valid choices.

attitude_type

Get the type of attitude profile.

eclipse_bodies

Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.

ground_ellipses

Get the ground ellipses properties.

lighting_maximum_step

Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.

route

Get the route properties.

route_supported_types

Return an array of valid choices.

route_type

Get the propagator type.

use_terrain_in_lighting_computations

Opt whether to compute lighting using terrain data.

Import detail#

from ansys.stk.core.stkobjects import IGreatArcVehicle

Property detail#

property IGreatArcVehicle.access_constraints: AccessConstraintCollection#

Get the constraints imposed on the vehicle.

property IGreatArcVehicle.attitude: IVehicleAttitude#

Get the attitude profile.

property IGreatArcVehicle.attitude_supported_types: list#

Return an array of valid choices.

property IGreatArcVehicle.attitude_type: VehicleAttitude#

Get the type of attitude profile.

property IGreatArcVehicle.eclipse_bodies: VehicleEclipseBodies#

Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.

property IGreatArcVehicle.ground_ellipses: VehicleGroundEllipsesCollection#

Get the ground ellipses properties.

property IGreatArcVehicle.lighting_maximum_step: float#

Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.

property IGreatArcVehicle.route: IPropagator#

Get the route properties.

property IGreatArcVehicle.route_supported_types: list#

Return an array of valid choices.

property IGreatArcVehicle.route_type: PropagatorType#

Get the propagator type.

property IGreatArcVehicle.use_terrain_in_lighting_computations: bool#

Opt whether to compute lighting using terrain data.

Method detail#

IGreatArcVehicle.is_attitude_type_supported(self, attitude: VehicleAttitude) bool#

Get a value indicating whether the specified type can be used.

Parameters:

attitude : VehicleAttitude

Returns:

bool

IGreatArcVehicle.is_route_type_supported(self, route: PropagatorType) bool#

Get a value indicating whether the specified type can be used.

Parameters:

route : PropagatorType

Returns:

bool

IGreatArcVehicle.set_attitude_type(self, attitude: VehicleAttitude) None#

Set the type of attitude profile.

Parameters:

attitude : VehicleAttitude

Returns:

None

IGreatArcVehicle.set_route_type(self, route: PropagatorType) None#

Set the propagator type.

Parameters:

route : PropagatorType

Returns:

None