AntennaVolumeLevelCollection#
- class ansys.stk.core.stkobjects.AntennaVolumeLevelCollection#
Class defining a collection of antenna volume levels.
Overview#
Given an index, returns the element in the collection. |
|
Check whether the collection contains an object with the given value. |
|
Remove the level with the corresponding value. |
|
Remove the level with the supplied index. |
|
Add and returns a new level with the corresponding value. |
|
Clear all contour levels from the collection. |
|
Get the level with the specified value. |
Import detail#
from ansys.stk.core.stkobjects import AntennaVolumeLevelCollection
Property detail#
- property AntennaVolumeLevelCollection._new_enum: EnumeratorProxy#
Return an enumerator for the collection.
Method detail#
- AntennaVolumeLevelCollection.item(self, index: int) → AntennaVolumeLevel#
Given an index, returns the element in the collection.
- Parameters:
index :
int
- Returns:
AntennaVolumeLevel
- AntennaVolumeLevelCollection.contains(self, value: float) → bool#
Check whether the collection contains an object with the given value.
- AntennaVolumeLevelCollection.remove(self, value: float) → None#
Remove the level with the corresponding value.
- AntennaVolumeLevelCollection.remove_at(self, index: int) → None#
Remove the level with the supplied index.
- 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:
- AntennaVolumeLevelCollection.get_level(self, value: float) → AntennaVolumeLevel#
Get the level with the specified value.
- Parameters:
value :
float
- Returns:
AntennaVolumeLevel