AntennaControl#

class ansys.stk.core.stkobjects.AntennaControl#

Class defining the properties for a antenna control.

Overview#

set_embedded_model

Do not use this method, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Sets the current antenna model by name.

reference_type

Get or set the antenna control reference type.

supported_linked_antenna_objects

Get an array of available antenna objects that this object can link to and use.

linked_antenna_object

Get or set the linked antenna object.

supported_embedded_models

Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets an array of supported model names.

embedded_model

Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets the current antenna model.

embedded_model_orientation

Get or set the antenna orientation.

embedded_model_component_linking

Get the link/embed controller for managing the embedded antenna model component.

Import detail#

from ansys.stk.core.stkobjects import AntennaControl

Property detail#

property AntennaControl.reference_type: AntennaControlReferenceType#

Get or set the antenna control reference type.

property AntennaControl.supported_linked_antenna_objects: list#

Get an array of available antenna objects that this object can link to and use.

property AntennaControl.linked_antenna_object: str#

Get or set the linked antenna object.

property AntennaControl.supported_embedded_models: list#

Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets an array of supported model names.

property AntennaControl.embedded_model: IAntennaModel#

Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets the current antenna model.

property AntennaControl.embedded_model_orientation: IOrientation#

Get or set the antenna orientation.

property AntennaControl.embedded_model_component_linking: IComponentLinkEmbedControl#

Get the link/embed controller for managing the embedded antenna model component.

Method detail#

AntennaControl.set_embedded_model(self, model_name: str) None#

Do not use this method, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Sets the current antenna model by name.

Parameters:

model_name : str

Returns:

None