Class GainSchedParameters

Parameters data class of the GainSchedModel

Inheritance

object

ModelParametersBaseClass

GainSchedParameters

Inherited Members

ModelParametersBaseClass.Fitting

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: TimeSeriesAnalysis.Dynamic

Assembly: TimeSeriesAnalysis.dll

Syntax

public class GainSchedParameters : ModelParametersBaseClass

Constructors

GainSchedParameters(double, double)

Default constructor

Declaration

public GainSchedParameters(double OperatingPoint_U = 0, double OperatingPoint_Y = 0)

Parameters

Type	Name	Description
double	OperatingPoint_U
double	OperatingPoint_Y

GainSchedParameters(GainSchedParameters)

Creates a new object that copies properties from an existing model.

Declaration

public GainSchedParameters(GainSchedParameters existingModel)

Parameters

Type	Name	Description
GainSchedParameters	existingModel	the model to be copied

Fields

FittingSpecs

The defined constraints on fitting, and defines an operating point if applicable.

Declaration

public FittingSpecs FittingSpecs

Field Value

Type	Description
FittingSpecs

GainSchedParameterIndex

The index of the scheduling-parameter among the model inputs(by default the first input is the schedulng variable)

Declaration

public int GainSchedParameterIndex

Field Value

Type	Description
int

Y_max

the maximum allowed output value(if set to NaN, no maximum is applied)

Declaration

public double Y_max

Field Value

Type	Description
double

Y_min

The minimum allowed output value(if set to NaN, no minimum is applied)

Declaration

public double Y_min

Field Value

Type	Description
double

Properties

LinearGainThresholds

Threshold for when to use different LinearGains, the size should be one less than LinearGains

Declaration

public double[] LinearGainThresholds { get; set; }

Property Value

Type	Description
double[]

LinearGainUnc

An array of 95% uncertatinty in the linear gains (u-u0))

Declaration

public List<double[]> LinearGainUnc { get; set; }

Property Value

Type	Description
List<double[]>

LinearGains

An list of arrays of gains that determine how much in the steady state each input change affects the output(multiplied with (u-u0)) The size of the list should be one higher than the size of LinearGainThresholds.

Declaration

public List<double[]> LinearGains { get; set; }

Property Value

Type	Description
List<double[]>

TimeConstantThresholds

Thresholds for when to use timeconstants.

Declaration

public double[] TimeConstantThresholds { get; set; }

Property Value

Type	Description
double[]

TimeConstantUnc_s

The uncertinty of the time constant estimate

Declaration

public double[] TimeConstantUnc_s { get; set; }

Property Value

Type	Description
double[]

TimeConstant_s

A time constant in seconds, the time a 1. order linear system requires to do 63% of a step response. Set to zero to turn off time constant in model.

Declaration

public double[] TimeConstant_s { get; set; }

Property Value

Type	Description
double[]

TimeDelay_s

The time delay in seconds.This number needs to be a multiple of the sampling rate. Set to zero to turn off time delay in model. There is no scheduling on the time delay.

Declaration

public double TimeDelay_s { get; set; }

Property Value

Type	Description
double

Methods

AddWarning(GainSchedIdentWarnings)

Adds a identifiation warning to the object

Declaration

public void AddWarning(GainSchedIdentWarnings warning)

Parameters

Type	Name	Description
GainSchedIdentWarnings	warning

GetBias()

Returns the bias calculated from OperatingPoint_U, OperatingPoint_Y;

Declaration

public double GetBias()

Returns

Type	Description
double

GetNumInputs()

Get the number of inputs U to the model.

Declaration

public int GetNumInputs()

Returns

Type	Description
int

GetOperatingPointU()

Get the U of the operating point

Declaration

public double GetOperatingPointU()

Returns

Type	Description
double

GetOperatingPointY()

Get the Y of the operating point

Declaration

public double GetOperatingPointY()

Returns

Type	Description
double

GetWarningList()

Get the list of all warnings given during identification of the model

Declaration

public List<GainSchedIdentWarnings> GetWarningList()

Returns

Type	Description
List<GainSchedIdentWarnings>

IncreaseOperatingPointY(double)

Changes the operating point by a given delta.

Give negative values to decrease the operating point.

Declaration

public void IncreaseOperatingPointY(double deltaOperatingPoint_Y)

Parameters

Type	Name	Description
double	deltaOperatingPoint_Y

IntegrateGains(double, double, int)

Integrate a model from a start point to an end point Note that this method currently does not work if some gains are null.

Declaration

public double IntegrateGains(double uGainSched_Start, double uGainSched_End, int inputIndex)

Parameters

Type	Name	Description
double	uGainSched_Start
double	uGainSched_End
int	inputIndex

Returns

Type	Description
double

MoveOperatingPointUWithoutChangingModel(double)

Sets a new operating point U, and adjusts the operating point Y so that the model output will be the same as before the change

Declaration

public void MoveOperatingPointUWithoutChangingModel(double newOperatingPointU)

Parameters

Type	Name	Description
double	newOperatingPointU	the new desired operating point

SetOperatingPoint(double, double)

This set the (u,y) through which a model may pass.

Careful! only use this when initalizing a new model, otherwise, you should use MoveOperatingPointUWithoutChangingModel to preserve model behavior

Declaration

public void SetOperatingPoint(double newOperatingPointU, double newOperatingPointY)

Parameters

Type	Name	Description
double	newOperatingPointU
double	newOperatingPointY