AntennaBeamCollection

class ansys.stk.core.stkobjects.AntennaBeamCollection

Class defining an antenna beam collection.

Overview

Methods

item	Given an index, returns the element in the collection.
remove_at	Remove the layer with the specified index.
insert_at	Insert a new beam at the supplied index.
add	Add a new beam to the collection.

Properties

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 AntennaBeamCollection

Property detail

property AntennaBeamCollection.count: int

Return the number of elements in the collection.

property AntennaBeamCollection._new_enum: EnumeratorProxy

Return an enumerator for the collection.

Method detail

AntennaBeamCollection.item(self, index: int) → IAntennaBeam

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

IAntennaBeam

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

Remove the layer with the specified index.

Parameters:

index : int

Returns:

None

AntennaBeamCollection.insert_at(self, index: int) → IAntennaBeam

Insert a new beam at the supplied index.

Parameters:

index : int

Returns:

IAntennaBeam

AntennaBeamCollection.add(self) → IAntennaBeam

Add a new beam to the collection.

Returns:

IAntennaBeam