AdvCATChosenObjectCollection

class ansys.stk.core.stkobjects.AdvCATChosenObjectCollection

The chosen object collection.

Overview

Methods

item	Given an index, returns a chosen object in the collection.
remove_at	Remove an object from the collection using specified index.
remove_all	Remove all elements from the collection.
add	Add a new chosen object to the collection.

Properties

count	Return the number of chosen objects in a collection.
_new_enum	Return an enumerator that can iterate through the collection.

Import detail

from ansys.stk.core.stkobjects import AdvCATChosenObjectCollection

Property detail

property AdvCATChosenObjectCollection.count: int

Return the number of chosen objects in a collection.

property AdvCATChosenObjectCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

Method detail

AdvCATChosenObjectCollection.item(self, index: int) → AdvCATChosenObject

Given an index, returns a chosen object in the collection.

Parameters:

index : int

Returns:

AdvCATChosenObject

AdvCATChosenObjectCollection.remove_at(self, index: int) → None

Remove an object from the collection using specified index.

Parameters:

index : int

Returns:

None

AdvCATChosenObjectCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

AdvCATChosenObjectCollection.add(self, object: str) → AdvCATChosenObject

Add a new chosen object to the collection.

Parameters:

object : str

Returns:

AdvCATChosenObject