Class TransmitterPacketCorruptionErrorModel

Namespace

NominalSystems.Classes

Assembly

NominalSystems.Classes.dll

[Nominal] This implements a data loss model which adjusts the fraction that the transmitter looses data. This will corrupt data produced by the transmitter.

---

[UniverseParent(typeof(Transmitter))]
public class TransmitterPacketCorruptionErrorModel : UniverseModel

Inheritance

object

Simulation.Object

UniverseEvent

UniverseModel

TransmitterPacketCorruptionErrorModel

Constructors

TransmitterPacketCorruptionErrorModel()

Default constructor

protected TransmitterPacketCorruptionErrorModel()

Fields

PacketCorruptionFraction

The fraction between 0 and 1 that a particular packet will be corrupted.

[Unit(UnitType.NONE)]
[Range(0, 1)]
public double PacketCorruptionFraction

Field Value

double

Methods

OnBegin(double)

Called when the object is beginning ticking for the first time. This is when the simulation calls the very first tick and will run before the update call.

protected override void OnBegin(double time)

Parameters

time double

[s] Current time of the simulation before the tick

OnFinish(double)

Called when the object is deleted from the simulation and can handle any cleanup of variables.

protected override void OnFinish(double time)

Parameters

time double

[s] The current clock time when deleted

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