IMCSSegment

class ansys.stk.core.stkobjects.astrogator.IMCSSegment

General properties for segments.

Overview

Methods

get_result_value	Return a result value.
run	Run the segment in individual segment mode. See MCSDriver.

Properties

type	Return the type of segment.
properties	Return the properties of the segment.
initial_state	Get the initial state of the segment.
final_state	Get the final state of the segment.
results	Get the results of the segment.
segment_summary	Get the segment summary report.

Import detail

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

Property detail

property IMCSSegment.type: SegmentType

Return the type of segment.

property IMCSSegment.properties: MCSSegmentProperties

Return the properties of the segment.

property IMCSSegment.initial_state: State

Get the initial state of the segment.

property IMCSSegment.final_state: State

Get the final state of the segment.

property IMCSSegment.results: CalculationObjectCollection

Get the results of the segment.

property IMCSSegment.segment_summary: IDataProviderResult

Get the segment summary report.

Method detail

IMCSSegment.get_result_value(self, result_name: str) → Any

Return a result value.

Parameters:

result_name : str

Returns:

Any

IMCSSegment.run(self) → State

Run the segment in individual segment mode. See MCSDriver.

Returns:

State