CoverageAssetListCollection#

class ansys.stk.core.stkobjects.CoverageAssetListCollection#

Asset List.

Overview#

item

Given an index, returns an element in the collection.

remove_at

Remove an element from the collection using specified index.

remove_all

Remove all elements from the collection.

add

Add a new element to the collection.

remove

Remove an element from the collection given a ObjectPath.

get_asset_from_path

Retrieve an element, given an object path.

is_asset_assigned

Return true if an asset is already assigned.

can_assign_asset

Return true is you can assign an asset.

count

Return the number of elements in a collection.

_new_enum

Return an enumerator that can iterate through the collection.

available_assets

Available objects to assign as coverage assets.

Import detail#

from ansys.stk.core.stkobjects import CoverageAssetListCollection

Property detail#

property CoverageAssetListCollection.count: int#

Return the number of elements in a collection.

property CoverageAssetListCollection._new_enum: EnumeratorProxy#

Return an enumerator that can iterate through the collection.

property CoverageAssetListCollection.available_assets: list#

Available objects to assign as coverage assets.

Method detail#

CoverageAssetListCollection.item(self, index: int) CoverageAssetListElement#

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

CoverageAssetListElement

CoverageAssetListCollection.remove_at(self, index: int) None#

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

CoverageAssetListCollection.remove_all(self) None#

Remove all elements from the collection.

Returns:

None

CoverageAssetListCollection.add(self, object_path: str) CoverageAssetListElement#

Add a new element to the collection.

Parameters:

object_path : str

Returns:

CoverageAssetListElement

CoverageAssetListCollection.remove(self, object_path: str) None#

Remove an element from the collection given a ObjectPath.

Parameters:

object_path : str

Returns:

None

CoverageAssetListCollection.get_asset_from_path(self, object_path: str) CoverageAssetListElement#

Retrieve an element, given an object path.

Parameters:

object_path : str

Returns:

CoverageAssetListElement

CoverageAssetListCollection.is_asset_assigned(self, object_path: str) bool#

Return true if an asset is already assigned.

Parameters:

object_path : str

Returns:

bool

CoverageAssetListCollection.can_assign_asset(self, object_path: str) bool#

Return true is you can assign an asset.

Parameters:

object_path : str

Returns:

bool