Class PidParameters

Namespace

TimeSeriesAnalysis.Dynamic

Assembly

TimeSeriesAnalysis.dll

Parameters of the PIDModel PidModel PidController

public class PidParameters : ModelParametersBaseClass

Inheritance

object

ModelParametersBaseClass

PidParameters

Inherited Members

ModelParametersBaseClass.Fitting

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

PidParameters()

Default constructor

public PidParameters()

PidParameters(PidParameters)

Constructor that copies an existing paramter set into a new object

public PidParameters(PidParameters existingParam)

Parameters

existingParam PidParameters

Fields

DelayOutputOneSample

If true, the model will set u[k] based on the error term e[k-1], if false it will be set from e[k]

public bool DelayOutputOneSample

Field Value

bool

Properties

AntiSurgeParams

PID anti-surge parameters object. This is optional, set to null if not anti-surge PID

public PidAntiSurgeParams AntiSurgeParams { get; set; }

Property Value

PidAntiSurgeParams

FeedForward

Feed-forward parameters object. This is optional, set to null when feedforward is not in use.

public PidFeedForward FeedForward { get; set; }

Property Value

PidFeedForward

Filtering

PID-filtering object. This is optional

public PidFilterParams Filtering { get; set; }

Property Value

PidFilterParams

GainScheduling

Gain-scheduling object. This is optional, set to null gain-scheduling is not in use.

public PidGainScheduling GainScheduling { get; set; }

Property Value

PidGainScheduling

Kp

Proportional gain of controller

public double Kp { get; set; }

Property Value

double

NanValue

If the PID-controller is to be protected from a specific value that is used to identify bad or missing data, specify here

public double NanValue { get; set; }

Property Value

double

Scaling

PID-scaling object. This is optional, set to null to use unscaled PID.

public PidScaling Scaling { get; set; }

Property Value

PidScaling

Td_s

Derivative term time constant[in seconds], 0 = no derivative term

public double Td_s { get; set; }

Property Value

double

Ti_s

Integral time constant [in seconds], 0 = no integral term

public double Ti_s { get; set; }

Property Value

double

u0

Output value when e=0, used only for P-only controllers, u = Kp*e + u0

public double u0 { get; set; }

Property Value

double

Methods

AddWarning(PidIdentWarning)

Store a warning that arouse during identification

public void AddWarning(PidIdentWarning warning)

Parameters

warning PidIdentWarning

GetWarnings()

Gives any warnings that occured during identification

public PidIdentWarning[] GetWarnings()

Returns

PidIdentWarning[]

ToString()

Creates a string summarizing the content of the paramters(useful for unit testing and debugging)

public override string ToString()

Returns

string