Class PowerCurrentLimiter

Namespace

NominalSystems.Classes

Assembly

NominalSystems.Classes.dll

[Nominal] A current limiter is able to disable a part of the circuit when the current exceeds a threshold.

---

public class PowerCurrentLimiter : PowerComponent, IPowerInterface

Inheritance

object

Simulation.Object

UniverseEvent

UniverseObject

PhysicalObject

PowerComponent

PowerCurrentLimiter

Implements

IPowerInterface

Constructors

PowerCurrentLimiter()

Default constructor

protected PowerCurrentLimiter()

Fields

CurrentLimit

The max current limit

[Unit(UnitType.AMPERE)]
[Range(0, 1.7976931348623157E+308)]
public double CurrentLimit

Field Value

double

IsLimited

A flag for if the current is being limited by the current limiter

public bool IsLimited

Field Value

bool

PreviousCurrent

The previous current if the current was limited

[Unit(UnitType.AMPERE)]
[ReadOnly]
[Metadata(IsAdvanced = true)]
public double PreviousCurrent

Field Value

double

Methods

BuildPower(string, string)

Builds the power components based on the power bus reference. Here, the interfaced component will be able to assign its SPICE components to the power bus. This will return an array of IEntity objects that represent the SPICE components.

[Hidden]
public override IEntity[] BuildPower(string negative, string positive)

Parameters

negative string

The input node for the entity

positive string

The output node for the entity

Returns

IEntity[]

ConfigurePower(double)

Configures the power interface to its default state, which will include updating the variables of any SPICE power components to the correct state.

public override bool ConfigurePower(double step)

Parameters

step double

[s] The step time for the circuit run

Returns

bool

A success flag

ExportPower(OP)

Exports the power from the SPICE (OP) simulation to the power interface, updating any relevant data.

[Hidden]
public override void ExportPower(OP simulation)

Parameters

simulation OP

The SPICE OP simulation

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

OnSave()

Called before the object is saved into the save state. This ensures that any additional metadata can be saved on the object before it is automatically serialized.

protected override void OnSave()

ResetPower()

Resets the power interface to its default state, which will include removing any SPICE power references associated to the current interface.

public override void ResetPower()