Class Export<S, T>
A template for exporting data for a simulation.
Inheritance
Export<S, T>
Implements
IExport<T>
Inherited Members
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public abstract class Export<S, T> : IExport<T> where S : IEventfulSimulation
Type Parameters
Name | Description |
---|---|
S | The simulation for which the export works. |
T | The base value type. |
Constructors
Export(S)
Initializes a new instance of the Export<S, T> class.
Declaration
protected Export(S simulation)
Parameters
Type | Name | Description |
---|---|---|
S | simulation | The simulation. |
Properties
Extractor
Gets or sets the extractor function.
Declaration
protected Func<T> Extractor { get; set; }
Property Value
Type | Description |
---|---|
Func<T> |
IsValid
Returns true if the exporter is currently valid.
Declaration
public bool IsValid { get; }
Property Value
Type | Description |
---|---|
bool |
Simulation
Gets the simulation from which the data needs to be extracted.
Declaration
public S Simulation { get; set; }
Property Value
Type | Description |
---|---|
S |
Value
Gets the current value from the simulation.
Declaration
public T Value { get; }
Property Value
Type | Description |
---|---|
T |
Remarks
This property will return a default if there is nothing to extract.
Methods
Destroy()
Destroys the export.
Declaration
public virtual void Destroy()
Finalize(object, EventArgs)
Finalizes the export.
Declaration
protected virtual void Finalize(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
object | sender | The object (simulation) sending the event. |
EventArgs | e | The EventArgs instance containing the event data. |
Initialize(object, EventArgs)
Initializes the export.
Declaration
protected abstract void Initialize(object sender, EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
object | sender | The object (simulation) sending the event. |
EventArgs | e | The EventArgs instance containing the event data. |
LazyLoad()
Load the export extractor if the simulation has already started.
Declaration
protected void LazyLoad()