Class PowerMonitor

Namespace

NominalSystems.Classes

Assembly

NominalSystems.Classes.dll

A power monitor is able to produce metrics from the power system and allow for enabling and disabling of particular component powers.

public class PowerMonitor : Component, IPowerAttachment

Inheritance

object

Component

PowerMonitor

Implements

IPowerAttachment

Inherited Members

Component.IsEnabled

Component.OnBegin(double)

Component.OnFinish(double)

Component.OnReset(double)

Component.OnPreAttachChild(Component)

Component.OnPreDetachChild(Component)

Component.OnPostAttachChild(Component)

Component.OnPostDetachChild(Component)

Component.IsChildTypeSupported(Type)

Component.IsModelTypeSupported(Type)

Component.Destroy(double)

Component.StopEvent(Guid)

Component.AddDelayEvent(Action, double)

Component.AddDelayEvent(Action<double>, double)

Component.AddRepeatEvent(Action, double)

Component.AddRepeatEvent(Action<double>, double)

Component.AddRepeatEvent(Action<double, double>, double)

Component.Add<T>()

Component.GetModel<T>()

Component.GetChild<T>(bool)

Component.GetParent<T>(bool)

Component.GetSystem<T>()

Component.GetChildren<T>(bool)

Component.RemoveChild<T>(T)

Component.FindObjectWithID(Guid)

Component.FindObjectWithID<T>(Guid)

Component.FindObjectWithType<T>()

Component.FindObjectsWithType<T>()

Component.IsRunning

Component.ID

Constructors

PowerMonitor()

Default constructor

public PowerMonitor()

Fields

Out_PowerMonitorMsg

The message with updates about the current system

public PowerMonitorMessage Out_PowerMonitorMsg

Field Value

PowerMonitorMessage

Methods

Connect(PowerBus)

Connects to a particular power bus and is able to start returning data from it.

public void Connect(PowerBus bus)

Parameters

bus PowerBus

The bus to connect to

OnDecodeMetadata(JObject)

Called after the "Component" was loaded to handle additional metadata.

protected override void OnDecodeMetadata(JObject metadata)

Parameters

metadata JObject

OnEncodeMetadata(JObject)

Called while the "Component" is being saved to save additional metadata.

protected override JObject OnEncodeMetadata(JObject metadata)

Parameters

metadata JObject

Returns

JObject

OnUpdate(double, double)

Called when the 'Component' should update

protected override void OnUpdate(double time, double step)

Parameters

time double

current time (seconds)

step double

the time step (seconds)