AntennaContourLevelCollection#

class ansys.stk.core.stkobjects.AntennaContourLevelCollection#

Class defining a collection of antenna contour levels.

Overview#

item

Given an index, returns the element in the collection.

contains

Check whether the collection contains an object with the given value.

remove

Remove the level with the corresponding value.

remove_at

Remove the level with the supplied index.

add

Add and returns a new level with the corresponding value.

clear

Clear all contour levels from the collection.

get_level

Get the level with the specified value.

count

Return the number of elements in the collection.

_new_enum

Return an enumerator for the collection.

Import detail#

from ansys.stk.core.stkobjects import AntennaContourLevelCollection

Property detail#

property AntennaContourLevelCollection.count: int#

Return the number of elements in the collection.

property AntennaContourLevelCollection._new_enum: EnumeratorProxy#

Return an enumerator for the collection.

Method detail#

AntennaContourLevelCollection.item(self, index: int) AntennaContourLevel#

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

AntennaContourLevel

AntennaContourLevelCollection.contains(self, value: float) bool#

Check whether the collection contains an object with the given value.

Parameters:

value : float

Returns:

bool

AntennaContourLevelCollection.remove(self, value: float) None#

Remove the level with the corresponding value.

Parameters:

value : float

Returns:

None

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

Remove the level with the supplied index.

Parameters:

index : int

Returns:

None

AntennaContourLevelCollection.add(self, value: float) AntennaContourLevel#

Add and returns a new level with the corresponding value.

Parameters:

value : float

Returns:

AntennaContourLevel

AntennaContourLevelCollection.clear(self) None#

Clear all contour levels from the collection.

Returns:

None

AntennaContourLevelCollection.get_level(self, value: float) AntennaContourLevel#

Get the level with the specified value.

Parameters:

value : float

Returns:

AntennaContourLevel