Description
The RFLinkComponent object holds information about how the transmitter and receiver are modeled in an RFLink object. This object is not creatable in script, but RFLinkComponents are always created as child objects of the RFLink object as seen in the example below:
RFLink1.Transmitter.Power = 200;
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.
Inheritance Hierarchy: ObjectàRFLinkComponent
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
AntennaDiameter
|
The diameter of the antenna. Used in the uniform gain calculation.
|
AntennaEfficiency
|
The unitless antenna efficiency. Used to calculate the owning component's effective gain when the gain type is Calculated Uniform Antenna Gain. The value is ignored for all other gain modes.
|
AntennaGainFile
|
The string containing the filename of the antenna pattern associated with the RFLinkComponent.
|
AntennaGainMatrix
|
The matrix containing the gain pattern of the RFLinkComponent.
|
DeclaredName
|
The name of the object as declared.
|
ExtrapolatedGain
|
The value filled in whenever gain must be extrapolated. Gain extrapolation will occur whenever a gain is needed for a region that lies outside the range of the component's antenna gain matrix. Be aware that no wrapping occurs between 0 and 360 degrees - if treating them as equal is desired, the provided antenna pattern must reflect that. Warning - altering this value can lead to incorrect conclusions about whether a link can be established. Since this value replaces all values outside of the range of the pattern, if this value is chosen to be in the range considered acceptable to establish a link, then false positives might be found.
|
GainType
|
Determines how the gain pattern is generated. Note that uniform antenna gain need not be isotropic.
|
LineLoss
|
Represents the aggregate of the losses incurred in the interior cables of the component. Used in the ERIP, transmitter power, and received power calculations.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
NoiseTemperature
|
Represents the noise temperature of the component including contributions from passive internal sub-components of the component and contriubutions from external noise sources such as cosmic noise, weather noise, etc. Used in the noise calculation.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
PointingLoss
|
Represents the losses caused by errors in the alignment of the component. Used in the ERIP, transmitter power, and received power calculations.
|
Power
|
The component's power. For a transmitter, this represents the power that will drive the signal, while for a receiver, this will represent the desired power on reception. Used in the EIRP, signal to noise ratio (C/N), and transmitter power calculations.
|
|
Name
|
Description
|
BuildAntennaGainGraphicsOverlay
|
Populates the provided graphics overlay with the contents of the antenna gain pattern. The geometry is scaled based on the value of meanRadius. The useGainScaling parameter determines whether the radius in a given direction is scaled based on the gain, or kept at a uniform length. The graphics overlay’s reference will be automatically set to the RFLinkComponent’s source object.
|
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.
|
LoadAntennaGainFile
|
Loads the provided antenna gain pattern file into a gain pattern matrix. Automatically updates the GainPatternType value to “Gain From Fileâ€.
|
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.
|
ResetReferenceObject
|
Removes the current source and resets any values derived from it.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetReferenceObject
|
Sets the object that the RFLinkComponent is located on.
|
SetUniformAntennaGain
|
Fills the RFLinkComponent's gain pattern matrix with a uniform gain pattern. Automatically updates the GainPatternTypeValue to "Uniform Antenna Gain".
|
|
|
