MCSSegmentCollection

class ansys.stk.core.stkobjects.astrogator.MCSSegmentCollection

Bases: IRuntimeTypeInfoProvider

The Mission Control Sequence.

Overview

Methods

item	Return the specified segment(using segment name or index number).
insert	Add a segment to the segment collection.
remove	Remove a segment; the End segment cannot be deleted.
remove_all	Remove all segments; the End segment cannot be deleted.
cut	Copy the segment into the clipboard and removes the segment from the sequence.
paste	Pastes the segment from the clipboard and inserts in before the given segment name.
insert_copy	Copy the segment pointer and inserts the copy before the given segment name.
insert_by_name	Insert a segment by name to the segment collection.
get_item_by_index	Retrieve the specified segment(using segment index number).
get_item_by_name	Retrieve the specified segment(using segment name).

Properties

_new_enum	Allow you to enumerate through the collection.
count	Return the size of the collection.
provide_runtime_type_info	Return the RuntimeTypeInfo interface to access properties at runtime.

Import detail

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

Property detail

property MCSSegmentCollection._new_enum: EnumeratorProxy

Allow you to enumerate through the collection.

property MCSSegmentCollection.count: int

Return the size of the collection.

property MCSSegmentCollection.provide_runtime_type_info: RuntimeTypeInfo

Return the RuntimeTypeInfo interface to access properties at runtime.

Method detail

MCSSegmentCollection.item(self, index_or_name: Any) → IMCSSegment

Return the specified segment(using segment name or index number).

Parameters:

index_or_name : Any

Returns:

IMCSSegment

MCSSegmentCollection.insert(self, segment_type: SegmentType, segment_name: str, segment_to_insert_before: str) → IMCSSegment

Add a segment to the segment collection.

Parameters:

segment_type : SegmentType

segment_name : str

segment_to_insert_before : str

Returns:

IMCSSegment

MCSSegmentCollection.remove(self, segment_name_to_remove: str) → None

Remove a segment; the End segment cannot be deleted.

Parameters:

segment_name_to_remove : str

Returns:

None

MCSSegmentCollection.remove_all(self) → None

Remove all segments; the End segment cannot be deleted.

Returns:

None

MCSSegmentCollection.cut(self, segment_name_to_cut: str) → None

Copy the segment into the clipboard and removes the segment from the sequence.

Parameters:

segment_name_to_cut : str

Returns:

None

MCSSegmentCollection.paste(self, segment_to_paste_before: str) → IMCSSegment

Pastes the segment from the clipboard and inserts in before the given segment name.

Parameters:

segment_to_paste_before : str

Returns:

IMCSSegment

MCSSegmentCollection.insert_copy(self, segment: IMCSSegment, segment_to_insert_before: str) → IMCSSegment

Copy the segment pointer and inserts the copy before the given segment name.

Parameters:

segment : IMCSSegment

segment_to_insert_before : str

Returns:

IMCSSegment

MCSSegmentCollection.insert_by_name(self, segment_name: str, segment_to_insert_before: str) → IMCSSegment

Insert a segment by name to the segment collection.

Parameters:

segment_name : str

segment_to_insert_before : str

Returns:

IMCSSegment

MCSSegmentCollection.get_item_by_index(self, index: int) → IMCSSegment

Retrieve the specified segment(using segment index number).

Parameters:

index : int

Returns:

IMCSSegment

MCSSegmentCollection.get_item_by_name(self, name: str) → IMCSSegment

Retrieve the specified segment(using segment name).

Parameters:

name : str

Returns:

IMCSSegment