CoverageAreaTargetsCollection

class ansys.stk.core.stkobjects.CoverageAreaTargetsCollection

Collection of Area Targets.

Overview

Methods

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 Target name.

Properties

count	Return the number of elements in a collection.
_new_enum	Return an enumerator that can iterate through the collection.
available_area_targets	Get the available area targets.

Import detail

from ansys.stk.core.stkobjects import CoverageAreaTargetsCollection

Property detail

property CoverageAreaTargetsCollection.count: int

Return the number of elements in a collection.

property CoverageAreaTargetsCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

property CoverageAreaTargetsCollection.available_area_targets: list

Get the available area targets.

Method detail

CoverageAreaTargetsCollection.item(self, index: int) → str

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

str

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

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

CoverageAreaTargetsCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

CoverageAreaTargetsCollection.add(self, target_name: str) → None

Add a new element to the collection.

Parameters:

target_name : str

Returns:

None

CoverageAreaTargetsCollection.remove(self, target_name: str) → None

Remove an element from the collection given a Target name.

Parameters:

target_name : str

Returns:

None