Table of Contents

Class ModelBaseClass

Namespace
TimeSeriesAnalysis.Dynamic
Assembly
TimeSeriesAnalysis.dll

Abstract base class that contains common functionality across all models which are to be implemented. ISimulatableModel

public abstract class ModelBaseClass
Inheritance
ModelBaseClass
Derived
Inherited Members

Fields

ModelInputIDs

Unique signal IDs that are mapped to the non-additive model inputs.

public string[] ModelInputIDs

Field Value

string[]

additiveInputIDs

Unique signal IDs that are added to the output of the model (typically a disturbance).

public List<string> additiveInputIDs

Field Value

List<string>

color

Optional color string when model is displayed as a graph.

public string color

Field Value

string

comment

Optional comment.

public string comment

Field Value

string

outputID

Unique signal ID that defines the name of output signal of the model.

public string outputID

Field Value

string

outputIdentID

Optional unique optional signal ID to be used for fitting/identification, if this is different from outputID. This tag is mainly for modeling estimated disturbance signals.

public string outputIdentID

Field Value

string

processModelType

The type of the model.

public ModelType processModelType

Field Value

ModelType

x

Optional visual position of model when displayed as graph: x-axis position (origo is top left).

public double? x

Field Value

double?

y

Optional visual position of model when displayed as graph: y-axis position (origo is top left).

public double? y

Field Value

double?

Properties

ID

A unique ID string that is used to identify the model uniquely in a PlantSimulation.

public string ID { get; set; }

Property Value

string

Methods

AddSignalToOutput(string)

Add an additive signal to the output.

public void AddSignalToOutput(string additiveInputID)

Parameters

additiveInputID string

ID of signal to add

GetAdditiveInputIDs()

Get the IDs of any additive inputs that are included in model.

public string[] GetAdditiveInputIDs()

Returns

string[]

returns null if no additive inputs are defined.

GetBothKindsOfInputIDs()

Get the IDs of both the model inputs and the additive model inputs.

public string[] GetBothKindsOfInputIDs()

Returns

string[]

GetID()

Get the ID of the model.

public string GetID()

Returns

string

GetLengthOfInputVector()

Get the length of the output vector.

public virtual int GetLengthOfInputVector()

Returns

int

GetModelInputIDs()

Get the type of the process model.

public string[] GetModelInputIDs()

Returns

string[]

GetOutputID()

Return the output ID.

public virtual string GetOutputID()

Returns

string

may return null if output is not set.

GetOutputIdentID()

Return the ID of the signal the output is identified against.

public virtual string GetOutputIdentID()

Returns

string

may return null if output is not set.

GetOutputSignalType()

Get the type of the output signal.

public abstract SignalType GetOutputSignalType()

Returns

SignalType

GetProcessModelType()

Get the type of the process model.

public ModelType GetProcessModelType()

Returns

ModelType

SetID(string)

Set the ID of the model.

public void SetID(string ID)

Parameters

ID string

SetInputIDs(string[], int?)

Set the stringIDs of one or more of the manipulated variables U that enter model. This method may append/lengthen the inputIDs.

public bool SetInputIDs(string[] U_stringIDs, int? idx = null)

Parameters

U_stringIDs string[]
idx int?

if non-null, this is the index of the element in U to set (U_stringIDs should then have just one element)

Returns

bool

SetOutputID(string)

Set the ID of the output.

public void SetOutputID(string outputID)

Parameters

outputID string

SetProcessModelType(ModelType)

Set the type of the process model.

public void SetProcessModelType(ModelType newType)

Parameters

newType ModelType
Edit this page