IAntennaBeam

class ansys.stk.core.stkobjects.IAntennaBeam

Provide access to an antenna beam.

Overview

Methods

set_polarization_type

Set the current polarization type.

Properties

identifier	Get or set the antenna beam identifier.
is_active	Get or set the beam active flag.
frequency	Get or set the beam frequency.
supported_antenna_models	Get an array of supported antenna model names.
antenna_model_name	Get or set the current antenna model by name.
antenna_model	Get the current antenna model.
orientation	Get the antenna orientation.
enable_polarization	Get or set the enable polarization option.
polarization	Get the polarization.

Import detail

from ansys.stk.core.stkobjects import IAntennaBeam

Property detail

property IAntennaBeam.identifier: str

Get or set the antenna beam identifier.

property IAntennaBeam.is_active: bool

Get or set the beam active flag.

property IAntennaBeam.frequency: float

Get or set the beam frequency.

property IAntennaBeam.supported_antenna_models: list

Get an array of supported antenna model names.

property IAntennaBeam.antenna_model_name: str

Get or set the current antenna model by name.

property IAntennaBeam.antenna_model: IAntennaModel

Get the current antenna model.

property IAntennaBeam.orientation: IOrientation

Get the antenna orientation.

property IAntennaBeam.enable_polarization: bool

Get or set the enable polarization option.

property IAntennaBeam.polarization: IPolarization

Get the polarization.

Method detail

IAntennaBeam.set_polarization_type(self, value: PolarizationType) → None

Set the current polarization type.

Parameters:

value : PolarizationType

Returns:

None