Class ModelBaseClass

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

Inheritance
object
ModelBaseClass
Divide
GainSchedModel
PidModel
Select
UnitModel
Inherited Members
Namespace: TimeSeriesAnalysis.Dynamic
Assembly: TimeSeriesAnalysis.dll
Syntax
public abstract class ModelBaseClass

Fields

| Edit this page View Source

ModelInputIDs

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

Declaration
public string[] ModelInputIDs
Field Value
Type Description
string[]
| Edit this page View Source

additiveInputIDs

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

Declaration
public List<string> additiveInputIDs
Field Value
Type Description
List<string>
| Edit this page View Source

color

Optional color string when model is displayed as a graph.

Declaration
public string color
Field Value
Type Description
string
| Edit this page View Source

comment

Optional comment.

Declaration
public string comment
Field Value
Type Description
string
| Edit this page View Source

outputID

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

Declaration
public string outputID
Field Value
Type Description
string
| Edit this page View Source

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.

Declaration
public string outputIdentID
Field Value
Type Description
string
| Edit this page View Source

processModelType

The type of the model.

Declaration
public ModelType processModelType
Field Value
Type Description
ModelType
| Edit this page View Source

x

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

Declaration
public double? x
Field Value
Type Description
double?
| Edit this page View Source

y

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

Declaration
public double? y
Field Value
Type Description
double?

Properties

| Edit this page View Source

ID

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

Declaration
public string ID { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

AddSignalToOutput(string)

Add an additive signal to the output.

Declaration
public void AddSignalToOutput(string additiveInputID)
Parameters
Type Name Description
string additiveInputID

ID of signal to add
| Edit this page View Source

GetAdditiveInputIDs()

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

Declaration
public string[] GetAdditiveInputIDs()
Returns
Type Description
string[]

returns null if no additive inputs are defined.
| Edit this page View Source

GetBothKindsOfInputIDs()

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

Declaration
public string[] GetBothKindsOfInputIDs()
Returns
Type Description
string[]
| Edit this page View Source

GetID()

Get the ID of the model.

Declaration
public string GetID()
Returns
Type Description
string
| Edit this page View Source

GetLengthOfInputVector()

Get the length of the output vector.

Declaration
public virtual int GetLengthOfInputVector()
Returns
Type Description
int
| Edit this page View Source

GetModelInputIDs()

Get the type of the process model.

Declaration
public string[] GetModelInputIDs()
Returns
Type Description
string[]
| Edit this page View Source

GetOutputID()

Return the output ID.

Declaration
public virtual string GetOutputID()
Returns
Type Description
string

may return null if output is not set.
| Edit this page View Source

GetOutputIdentID()

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

Declaration
public virtual string GetOutputIdentID()
Returns
Type Description
string

may return null if output is not set.
| Edit this page View Source

GetOutputSignalType()

Get the type of the output signal.

Declaration
public abstract SignalType GetOutputSignalType()
Returns
Type Description
SignalType
| Edit this page View Source

GetProcessModelType()

Get the type of the process model.

Declaration
public ModelType GetProcessModelType()
Returns
Type Description
ModelType
| Edit this page View Source

SetID(string)

Set the ID of the model.

Declaration
public void SetID(string ID)
Parameters
Type Name Description
string ID
| Edit this page View Source

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.

Declaration
public bool SetInputIDs(string[] U_stringIDs, int? idx = null)
Parameters
Type Name Description
string[] U_stringIDs
int? idx

if non-null, this is the index of the element in U to set (U_stringIDs should then have just one element)
Returns
Type Description
bool
| Edit this page View Source

SetOutputID(string)

Set the ID of the output.

Declaration
public void SetOutputID(string outputID)
Parameters
Type Name Description
string outputID
| Edit this page View Source

SetProcessModelType(ModelType)

Set the type of the process model.

Declaration
public void SetProcessModelType(ModelType newType)
Parameters
Type Name Description
ModelType newType