AntennaVolumeLevelCollection#

class ansys.stk.core.stkobjects.AntennaVolumeLevelCollection#

Class defining a collection of antenna volume levels.

Overview#

add

Add and returns a new level with the corresponding value.

clear

Clear all contour levels from the collection.

contains

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

get_level

Get the level with the specified value.

item

Given an index, returns the element in the collection.

remove

Remove the level with the corresponding value.

remove_at

Remove the level with the supplied index.

_new_enum

Return an enumerator for the collection.

count

Return the number of elements in the collection.

Import detail#

from ansys.stk.core.stkobjects import AntennaVolumeLevelCollection

Property detail#

property AntennaVolumeLevelCollection._new_enum: EnumeratorProxy#

Return an enumerator for the collection.

property AntennaVolumeLevelCollection.count: int#

Return the number of elements in the collection.

Method detail#

AntennaVolumeLevelCollection.add(self, value: float) AntennaVolumeLevel#

Add and returns a new level with the corresponding value.

Parameters:

value : float

Returns:

AntennaVolumeLevel

AntennaVolumeLevelCollection.clear(self) None#

Clear all contour levels from the collection.

Returns:

None

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

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

Parameters:

value : float

Returns:

bool

AntennaVolumeLevelCollection.get_level(self, value: float) AntennaVolumeLevel#

Get the level with the specified value.

Parameters:

value : float

Returns:

AntennaVolumeLevel

AntennaVolumeLevelCollection.item(self, index: int) AntennaVolumeLevel#

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

AntennaVolumeLevel

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

Remove the level with the corresponding value.

Parameters:

value : float

Returns:

None

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

Remove the level with the supplied index.

Parameters:

index : int

Returns:

None