OpticalLinkAtmosphere Object

The OpticalLinkAtmosphere object models atmospheric effects on an optical communication link, including attenuation from visibility-driven scattering, rain, snow, and scintillation. It supports the configuration of parameters such as visibility distance, rain rate, snow rate, and fade probability, and provides methods for computing scattering loss, precipitation loss, and scintillation-induced link deficits. These models allow for realistic performance prediction for optical links under varying weather and turbulence conditions.

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DisplayName	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
GroundTurbulence	Ground turbulence constant in units of m^-2/3 to be used in Hufnagel-Valley turbulence profile.	Type: Variable Access: Read/Write Units: m^-2/3
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
PrecipitationPathLength	Distance in kilometers along the line of sight vector over which rain or snow is occurring.	Type: Variable Access: Read/Write Units: km
RainExponent	Rain loss is modeled as A * rate ^ B. This is the exponent B.	Type: Variable Access: Read/Write
RainFactor	Rain loss is modeled as A * rate ^ B. This is the factor A.	Type: Variable Access: Read/Write
RainRate	The meteorologically observed or predicted rainfall rate in mm/h.	Type: Variable Access: Read/Write Units: mm/hr
SnowRate	The meteorologically observed or predicted snowfall rate in mm/h.	Type: Variable Access: Read/Write Units: mm/hr
SnowType	Whether to assume dry snow (1) or wet snow (0). Snow loss is modeled as A * rate ^ B. This determines the appropriate set of A and B constants to use.	Type: Variable Access: Read/Write
UserSpecifiedLoss	Atmospheric loss in dB to be used in place of the atmospheric loss modeled by the properties of the AtmosphericLossParameters child object. This value replaces the built-in model's calculation if it is not set to the default value of zero.	Type: Variable Access: Read/Write Units: dB
UseWeakTurbulenceModel	Use the weak turbulence approximation for scintillation index calculations.	Type: Variable Access: Read/Write
VisibilityDistance	Meteorological visibility at the ground station in kilometers.	Type: Variable Access: Read/Write Units: km

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

OpticalLinkAtmosphere Object

Description

Available In Editions:

Timing Precision Mode