MCSSegmentProperties#

class ansys.stk.core.stkobjects.astrogator.MCSSegmentProperties#

Bases: IRuntimeTypeInfoProvider

Segment Properties.

Overview#

apply_final_state_to_b_planes

Apply the last calculated final state of the segment to all selected B-Planes.

display_coordinate_system

Get or set the coordinate system that will be used in the segment summary report.

color

Get or set the display color of the segment.

update_animation_time_after_run

If true, Astrogator will set the animation time to the final epoch of the segment when the segment finishes running.

b_planes

Get the B-Plane or B-Planes to which the epoch, position, and velocity of the segment’s final state will be applied, according to the B-Plane’s definition.

last_run_code

Get the last run code returned by the segment.

Import detail#

from ansys.stk.core.stkobjects.astrogator import MCSSegmentProperties

Property detail#

property MCSSegmentProperties.display_coordinate_system: str#

Get or set the coordinate system that will be used in the segment summary report.

property MCSSegmentProperties.color: Color#

Get or set the display color of the segment.

property MCSSegmentProperties.update_animation_time_after_run: bool#

If true, Astrogator will set the animation time to the final epoch of the segment when the segment finishes running.

property MCSSegmentProperties.b_planes: BPlaneCollection#

Get the B-Plane or B-Planes to which the epoch, position, and velocity of the segment’s final state will be applied, according to the B-Plane’s definition.

property MCSSegmentProperties.last_run_code: RunCode#

Get the last run code returned by the segment.

Method detail#

MCSSegmentProperties.apply_final_state_to_b_planes(self) None#

Apply the last calculated final state of the segment to all selected B-Planes.

Returns:

None