PropagationChannel#

class ansys.stk.core.stkobjects.PropagationChannel#: Class defining the propagation channel.

Overview#

Methods

`set_atmospheric_absorption_model`	Do not use this method, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Sets the atmospheric absorption model by name.
`set_rain_loss_model`	Do not use this method, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Sets the rain loss model by name.
`set_urban_terrestrial_loss_model`	Do not use this method, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Sets the urban/terrestrial loss model by name.
`set_clouds_and_fog_fading_loss_model`	Do not use this method, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Sets the CloudsAndFogFading loss model by name.
`set_tropospheric_scintillation_fading_loss_model`	Do not use this method, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Sets the Tropospheric Scintillation Fading loss model by name.
`set_ionospheric_fading_loss_model`	Do not use this method, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Sets the Ionospheric Fading loss model by name.

Properties

`enable_atmospheric_absorption`	Get or set the option to use the atmospheric absorption model.
`supported_atmospheric_absorption_models`	Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets an array of supported atmospheric absorption model names.
`atmospheric_absorption_model`	Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets the atmospheric absorption model.
`enable_rain_loss`	Get or set the option to use the rain loss model.
`supported_rain_loss_models`	Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets an array of supported rain loss model names.
`rain_loss_model`	Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets the rain loss model.
`custom_a`	Get the Custom A propagation model.
`custom_b`	Get the Custom B propagation model.
`custom_c`	Get the Custom C propagation model.
`enable_itu_618_section2_p5`	Get or set the option to enable the ITU 618 Section 2.5 model for computing total propagation loss.
`enable_urban_terrestrial_loss`	Get or set the option to use the urban/terrestrial loss model.
`supported_urban_terrestrial_loss_models`	Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets an array of supported urban/terrestrial loss model names.
`urban_terrestrial_loss_model`	Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets the urban/terrestrial loss model.
`supported_clouds_and_fog_fading_loss_models`	Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported CloudsAndFog Fading loss model names.
`clouds_and_fog_fading_loss_model`	Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets the CloudsAndFogFading loss model.
`supported_tropospheric_scintillation_fading_loss_models`	Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Tropospheric Scintillation Fading loss model names.
`tropospheric_scintillation_fading_loss_model`	Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets the Tropospheric Scintillation Fading loss model.
`supported_ionospheric_fading_loss_models`	Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Ionospheric Fading loss model names.
`ionospheric_fading_loss_model`	Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets the Ionospheric Fading loss model.
`enable_clouds_and_fog_fading_loss`	Get or set the option to use the clouds and fog fading loss model.
`enable_tropospheric_scintillation_fading_loss`	Get or set the option to use the tropospheric scintillation fading loss model.
`enable_ionospheric_fading_loss`	Get or set the option to use the ionoospheric fading loss model.
`atmospheric_absorption_model_component_linking`	Get the link/embed controller for managing the atmospheric absorption model component.
`rain_loss_model_component_linking`	Get the link/embed controller for managing the rain loss model component.
`urban_terrestrial_loss_model_component_linking`	Get the link/embed controller for managing the urban terrestrial loss model component.
`clouds_and_fog_fading_loss_model_component_linking`	Get the link/embed controller for managing the clouds and fog fading loss model component.
`tropospheric_scintillation_fading_loss_model_component_linking`	Get the link/embed controller for managing the tropospheric scintillation fading loss model component.
`ionospheric_fading_loss_model_component_linking`	Get the link/embed controller for managing the ionospheric fading loss model component.

Import detail#

from ansys.stk.core.stkobjects import PropagationChannel

Property detail#

property PropagationChannel.enable_atmospheric_absorption: bool#: Get or set the option to use the atmospheric absorption model.

property PropagationChannel.supported_atmospheric_absorption_models: list#: Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets an array of supported atmospheric absorption model names.

property PropagationChannel.atmospheric_absorption_model: IAtmosphericAbsorptionModel#: Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets the atmospheric absorption model.

property PropagationChannel.enable_rain_loss: bool#: Get or set the option to use the rain loss model.

property PropagationChannel.supported_rain_loss_models: list#: Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets an array of supported rain loss model names.

property PropagationChannel.rain_loss_model: IRainLossModel#: Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets the rain loss model.

property PropagationChannel.custom_a: CustomPropagationModel#: Get the Custom A propagation model.

property PropagationChannel.custom_b: CustomPropagationModel#: Get the Custom B propagation model.

property PropagationChannel.custom_c: CustomPropagationModel#: Get the Custom C propagation model.

property PropagationChannel.enable_itu_618_section2_p5: bool#: Get or set the option to enable the ITU 618 Section 2.5 model for computing total propagation loss.

property PropagationChannel.enable_urban_terrestrial_loss: bool#: Get or set the option to use the urban/terrestrial loss model.

property PropagationChannel.supported_urban_terrestrial_loss_models: list#: Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets an array of supported urban/terrestrial loss model names.

property PropagationChannel.urban_terrestrial_loss_model: IUrbanTerrestrialLossModel#: Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets the urban/terrestrial loss model.

property PropagationChannel.supported_clouds_and_fog_fading_loss_models: list#: Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported CloudsAndFog Fading loss model names.

property PropagationChannel.clouds_and_fog_fading_loss_model: ICloudsAndFogFadingLossModel#: Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets the CloudsAndFogFading loss model.

property PropagationChannel.supported_tropospheric_scintillation_fading_loss_models: list#: Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Tropospheric Scintillation Fading loss model names.

property PropagationChannel.tropospheric_scintillation_fading_loss_model: ITroposphericScintillationFadingLossModel#: Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets the Tropospheric Scintillation Fading loss model.

property PropagationChannel.supported_ionospheric_fading_loss_models: list#: Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Ionospheric Fading loss model names.

property PropagationChannel.ionospheric_fading_loss_model: IIonosphericFadingLossModel#: Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets the Ionospheric Fading loss model.

property PropagationChannel.enable_clouds_and_fog_fading_loss: bool#: Get or set the option to use the clouds and fog fading loss model.

property PropagationChannel.enable_tropospheric_scintillation_fading_loss: bool#: Get or set the option to use the tropospheric scintillation fading loss model.

property PropagationChannel.enable_ionospheric_fading_loss: bool#: Get or set the option to use the ionoospheric fading loss model.

property PropagationChannel.atmospheric_absorption_model_component_linking: IComponentLinkEmbedControl#: Get the link/embed controller for managing the atmospheric absorption model component.

property PropagationChannel.rain_loss_model_component_linking: IComponentLinkEmbedControl#: Get the link/embed controller for managing the rain loss model component.

property PropagationChannel.urban_terrestrial_loss_model_component_linking: IComponentLinkEmbedControl#: Get the link/embed controller for managing the urban terrestrial loss model component.

property PropagationChannel.clouds_and_fog_fading_loss_model_component_linking: IComponentLinkEmbedControl#: Get the link/embed controller for managing the clouds and fog fading loss model component.

property PropagationChannel.tropospheric_scintillation_fading_loss_model_component_linking: IComponentLinkEmbedControl#: Get the link/embed controller for managing the tropospheric scintillation fading loss model component.

property PropagationChannel.ionospheric_fading_loss_model_component_linking: IComponentLinkEmbedControl#: Get the link/embed controller for managing the ionospheric fading loss model component.

Method detail#

PropagationChannel.set_atmospheric_absorption_model(self, model_name: str) → None#

Do not use this method, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Sets the atmospheric absorption model by name.

Parameters:: model_name : str
Returns:: None

PropagationChannel.set_rain_loss_model(self, model_name: str) → None#

Do not use this method, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Sets the rain loss model by name.

Parameters:: model_name : str
Returns:: None

PropagationChannel.set_urban_terrestrial_loss_model(self, model_name: str) → None#

Do not use this method, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Sets the urban/terrestrial loss model by name.

Parameters:: model_name : str
Returns:: None

PropagationChannel.set_clouds_and_fog_fading_loss_model(self, model_name: str) → None#

Do not use this method, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Sets the CloudsAndFogFading loss model by name.

Parameters:: model_name : str
Returns:: None

PropagationChannel.set_tropospheric_scintillation_fading_loss_model(self, model_name: str) → None#

Do not use this method, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Sets the Tropospheric Scintillation Fading loss model by name.

Parameters:: model_name : str
Returns:: None

PropagationChannel.set_ionospheric_fading_loss_model(self, model_name: str) → None#

Do not use this method, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Sets the Ionospheric Fading loss model by name.

Parameters:: model_name : str
Returns:: None