CommSystem#

class ansys.stk.core.stkobjects.CommSystem#

Bases: ISTKObject, ILifetimeInformation

Class defining a CommSystem object.

Overview#

set_link_selection_criteria_type

Set the link selection criteria by name.

compute

Unconditionally computes the CommSystem.

clear

Unconditionally clears any computed values of the CommSystem.

transmitters

Get the transmitter collection.

receivers

Get the receiver collection.

interference_sources

Get the interference source collection.

calculate_interference

Get or set the option for calculating interference.

reference_bandwidth

Get or set the reference bandwidth.

constraining_role

Get or set the constraining role.

time_period

Allow configuring the time period.

step_size

Get or set the step size.

save_mode

Get or set the save mode.

access_options

Get the access options.

link_selection_criteria

Get the link selection criteria.

graphics

Get the 2D Graphics properties for the CommSystem.

graphics_3d

Get the 3D Graphics properties for the CommSystem.

include_receiver_interference_emitters

Get or set whether the emitters from each receiver is included in their interference computation.

Import detail#

from ansys.stk.core.stkobjects import CommSystem

Property detail#

property CommSystem.transmitters: ObjectLinkCollection#

Get the transmitter collection.

property CommSystem.receivers: ObjectLinkCollection#

Get the receiver collection.

property CommSystem.interference_sources: ObjectLinkCollection#

Get the interference source collection.

property CommSystem.calculate_interference: bool#

Get or set the option for calculating interference.

property CommSystem.reference_bandwidth: CommSystemReferenceBandwidth#

Get or set the reference bandwidth.

property CommSystem.constraining_role: CommSystemConstrainingRole#

Get or set the constraining role.

property CommSystem.time_period: ITimeToolTimeIntervalSmartInterval#

Allow configuring the time period.

property CommSystem.step_size: float#

Get or set the step size.

property CommSystem.save_mode: CommSystemSaveMode#

Get or set the save mode.

property CommSystem.access_options: CommSystemAccessOptions#

Get the access options.

Get the link selection criteria.

property CommSystem.graphics: CommSystemGraphics#

Get the 2D Graphics properties for the CommSystem.

property CommSystem.graphics_3d: CommSystemGraphics3D#

Get the 3D Graphics properties for the CommSystem.

property CommSystem.include_receiver_interference_emitters: bool#

Get or set whether the emitters from each receiver is included in their interference computation.

Method detail#

Set the link selection criteria by name.

Parameters:

value : CommSystemLinkSelectionCriteriaType

Returns:

None

CommSystem.compute(self) None#

Unconditionally computes the CommSystem.

Returns:

None

CommSystem.clear(self) None#

Unconditionally clears any computed values of the CommSystem.

Returns:

None