Description
The OpticalLinkTransmitter object defines the optical transmitter hardware for an OpticalLink. It includes parameters such as signal power, beam divergence, pointing loss, wavelength, and system losses, and supports modeling of space-based or ground-based transmitters. The object provides methods for calculating transmitter gain, free space loss, and received power at the optical receiver when combined with the receiver and atmospheric models.
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->OpticalLinkTransmitter
Parent Object: OpticalLink
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
BeamDivergence
|
The full width at half maximum (FWHM) angular divergence in radians of the transmitting beam.
|
Type: Variable
Access: Read/Write
|
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
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
PointingLoss
|
Represents the losses in dB caused by any error in alignment of the optical transmitter.
|
Type: Variable
Access: Read/Write
Units: dB
|
SignalPower
|
The signal power of the transmitter in watts.
|
Type: Variable
Access: Read/Write
Units: W
|
SystemLosses
|
Any additional losses, given in dB, which are present in the optical transmitter system (e.g. fiber coupling).
|
Type: Variable
Access: Read/Write
Units: dB
|
|
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.
|
GetPointingLossFromPointingError
|
Uses the BeamDivergence property and a provided 3-sigma pointing error in radians to get a pointing loss value in dB.
|
GetSignalPowerFromAveragePower
|
Uses the ModulationType property of OpticalLink to compute the signal power for a given average power in watts.
|
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 optical transmitter is located on.
|
|
|
