ProfileCollection

class ansys.stk.core.stkobjects.astrogator.ProfileCollection

Bases: IRuntimeTypeInfoProvider

The Profiles of a Target Sequence.

Overview

Methods

add	Add a profile.
add2	Add a profile.
cut	Copy the profile into the clipboard and removes profile from the list.
get_item_by_index	Retrieve a profile from the collection by index.
get_item_by_name	Retrieve a profile from the collection by name.
insert_copy	Copy the profile and inserts the copy into the list.
item	Allow you to iterate through the collection.
paste	Pastes the profile from the clipboard and inserts into the list.
remove	Remove an item from the profile collection.
remove_all	Remove all profiles from the profile collection.

Properties

_new_enum	Allow you to enumerate through the collection.
available_profiles	Return a list of available profiles.
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 ProfileCollection

Property detail

property ProfileCollection._new_enum: EnumeratorProxy

Allow you to enumerate through the collection.

property ProfileCollection.available_profiles: list

Return a list of available profiles.

property ProfileCollection.count: int

Return the size of the collection.

property ProfileCollection.provide_runtime_type_info: RuntimeTypeInfo

Return the RuntimeTypeInfo interface to access properties at runtime.

Method detail

ProfileCollection.add(self, profile_name: str) → IProfile

Add a profile.

Parameters:

profile_name : str

Returns:

IProfile

ProfileCollection.add2(self, profile_name: str, index_or_name: Any, direction: ProfileInsertDirection) → IProfile

Add a profile.

Parameters:

profile_name : str

index_or_name : Any

direction : ProfileInsertDirection

Returns:

IProfile

ProfileCollection.cut(self, index_or_name: Any) → None

Copy the profile into the clipboard and removes profile from the list.

Parameters:

index_or_name : Any

Returns:

None

ProfileCollection.get_item_by_index(self, index: int) → IProfile

Retrieve a profile from the collection by index.

Parameters:

index : int

Returns:

IProfile

ProfileCollection.get_item_by_name(self, name: str) → IProfile

Retrieve a profile from the collection by name.

Parameters:

name : str

Returns:

IProfile

ProfileCollection.insert_copy(self, profile: IProfile, index_or_name: Any, direction: ProfileInsertDirection) → IProfile

Copy the profile and inserts the copy into the list.

Parameters:

profile : IProfile

index_or_name : Any

direction : ProfileInsertDirection

Returns:

IProfile

ProfileCollection.item(self, index_or_name: Any) → IProfile

Allow you to iterate through the collection.

Parameters:

index_or_name : Any

Returns:

IProfile

ProfileCollection.paste(self, index_or_name: Any, direction: ProfileInsertDirection) → IProfile

Pastes the profile from the clipboard and inserts into the list.

Parameters:

index_or_name : Any

direction : ProfileInsertDirection

Returns:

IProfile

ProfileCollection.remove(self, index_or_profile_name: Any) → None

Remove an item from the profile collection.

Parameters:

index_or_profile_name : Any

Returns:

None

ProfileCollection.remove_all(self) → None

Remove all profiles from the profile collection.

Returns:

None