Table of Contents

Class OpticalReceiver

Namespace
NominalSystems.Classes
Assembly
NominalSystems.Classes.dll

[Nominal] An optical receiver is able to have a line of sight that is affected by the laser link that is set. The optical receiver is a form of a laser receiver that is able to receive data from a laser transmitter.


public class OpticalReceiver : Receiver
Inheritance
OpticalReceiver

Constructors

OpticalReceiver()

Default constructor

protected OpticalReceiver()

Fields

In_DeviceStatusMsg

The Device status message for the physical component whether the device is available.

public DeviceStatusMessage? In_DeviceStatusMsg

Field Value

DeviceStatusMessage

Methods

OnCreate()

Called when the 'Component' is created from the controller.

protected override void OnCreate()

OnLoad(double)

Called after all of the data has been loaded from a save state on this object. This enables any post-load operations to be performed and extra data to be loaded from the metadata.

protected override void OnLoad(double time)

Parameters

time double

[s] The current clock time of the simulation

OnUpdate(double, double)

Called when the object should update from the simulation tick. This will take in a time and a step, where the time is the time of the clock before updating the object.

protected override void OnUpdate(double time, double step)

Parameters

time double

[s] Current time of the simulation before the update

step double

[s] The time-step to update during this tick

SetLineOfSight(bool, Transmitter)

Updates the line of sight flag if this uses a particular transmission type that disables connection if the line of sight is blocked, for example, optical.

public void SetLineOfSight(bool los, Transmitter transmitter)

Parameters

los bool

A flag if the los is clear

transmitter Transmitter

The transmitter for the connection