CalculationObjectLinkEmbedControlCollection

class ansys.stk.core.stkobjects.astrogator.CalculationObjectLinkEmbedControlCollection

The Calculation Object link/embed component folder.

Overview

Methods

add	Add a link/embed calc object to the collection.
item	Return a link/embed calc object.
remove	Remove a link/embed calc object from the collection.
cut	Copy a link/embed calc object to the clipboard and removes the calc object from the list.
paste	Pastes a link/embed calc object from the clipboard into the list.
insert_copy	Copy a link/embed calc object and inserts the copy into the list.
get_item_by_index	Retrieve a link/embed calc object found by the index.
get_item_by_name	Retrieve a link/embed calc object found by the name.

Properties

_new_enum	Allow you to enumerate through the collection.
count	Return the size of the collection.

Import detail

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

Property detail

property CalculationObjectLinkEmbedControlCollection._new_enum: EnumeratorProxy

Allow you to enumerate through the collection.

property CalculationObjectLinkEmbedControlCollection.count: int

Return the size of the collection.

Method detail

CalculationObjectLinkEmbedControlCollection.add(self, name: str, ref_type: ComponentLinkEmbedControlReferenceType) → IComponentLinkEmbedControl

Add a link/embed calc object to the collection.

Parameters:

name : str

ref_type : ComponentLinkEmbedControlReferenceType

Returns:

IComponentLinkEmbedControl

CalculationObjectLinkEmbedControlCollection.item(self, index_or_name: Any) → IComponentLinkEmbedControl

Return a link/embed calc object.

Parameters:

index_or_name : Any

Returns:

IComponentLinkEmbedControl

CalculationObjectLinkEmbedControlCollection.remove(self, index_or_name: Any) → None

Remove a link/embed calc object from the collection.

Parameters:

index_or_name : Any

Returns:

None

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

Copy a link/embed calc object to the clipboard and removes the calc object from the list.

Parameters:

index_or_name : Any

Returns:

None

CalculationObjectLinkEmbedControlCollection.paste(self) → IComponentLinkEmbedControl

Pastes a link/embed calc object from the clipboard into the list.

Returns:

IComponentLinkEmbedControl

CalculationObjectLinkEmbedControlCollection.insert_copy(self, calc_obj: IComponentLinkEmbedControl) → IComponentLinkEmbedControl

Copy a link/embed calc object and inserts the copy into the list.

Parameters:

calc_obj : IComponentLinkEmbedControl

Returns:

IComponentLinkEmbedControl

CalculationObjectLinkEmbedControlCollection.get_item_by_index(self, index: int) → IComponentLinkEmbedControl

Retrieve a link/embed calc object found by the index.

Parameters:

index : int

Returns:

IComponentLinkEmbedControl

CalculationObjectLinkEmbedControlCollection.get_item_by_name(self, name: str) → IComponentLinkEmbedControl

Retrieve a link/embed calc object found by the name.

Parameters:

name : str

Returns:

IComponentLinkEmbedControl