Class ElectromagneticModel
- Namespace
- NominalSystems.Universe
- Assembly
- NominalSystems.Universe.dll
[Nominal] An electromagnetic (EM) model can be added to any universe object which is able to produce a signature in the EM spectrum. This will enable EM signature lookups or standard EM models.
public class ElectromagneticModel : UniverseModel<PhysicalObject>
- Inheritance
-
ElectromagneticModel
- Extension Methods
Constructors
ElectromagneticModel()
Default constructor
protected ElectromagneticModel()
Fields
FilePath
The file path for the electromagnetic lookup table.
[ReadOnly]
public string FilePath
Field Value
LookupMatrix
The database lookup matrix, if it exists
[Hidden]
public Matrix LookupMatrix
Field Value
Out_ElectromagneticSignatureMsg
The EM signature message that stores information about the current signature of the component.
public ElectromagneticSignatureMessage? Out_ElectromagneticSignatureMsg
Field Value
Properties
Frequency
The frequency of the signature in the EM spectrum.
[Unit(UnitType.HERTZ)]
public double Frequency { get; set; }
Property Value
IsInitialised
A flag whether the data has been loaded. This will ensure that on a new serialization, the data is reloaded.
[Hidden]
public bool IsInitialised { get; }
Property Value
Methods
GetElectromagneticLoss(double)
Calculates the Electro-Magnetic loss of the connection at some particular angel about the component, symmetric about the component's up vector.
public double GetElectromagneticLoss(double angle)
Parameters
angle
double[deg] The angle to calculate the loss at
Returns
- double
[dB] The loss of the EM signature
Initialise(string)
Loads the EM signature properties from a CSV table. This will read a CSV file and will interpolate the data to create a lookup table for the EM signature.
public bool Initialise(string filePath)
Parameters
filePath
stringThe full file path to the CSV file
Returns
- bool
A flag indicating whether the data was created correctly
OnCreate()
Called when the object is created from the controller and has been attached to the parent object. By this point, it has been registered to the simulation and will run after the constructor.
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