Search Results for

    Show / Hide Table of Contents

    Class PidParameters

    Parameters of the PIDModel PidModel PidController

    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)
    Namespace: TimeSeriesAnalysis.Dynamic
    Assembly: TimeSeriesAnalysis.dll
    Syntax
    public class PidParameters : ModelParametersBaseClass

    Constructors

    | Edit this page View Source

    PidParameters()

    Default constructor

    Declaration
    public PidParameters()
    | Edit this page View Source

    PidParameters(PidParameters)

    Constructor that copies an existing paramter set into a new object

    Declaration
    public PidParameters(PidParameters existingParam)
    Parameters
    Type Name Description
    PidParameters existingParam

    Fields

    | Edit this page View Source

    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]

    Declaration
    public bool DelayOutputOneSample
    Field Value
    Type Description
    bool

    Properties

    | Edit this page View Source

    AntiSurgeParams

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

    Declaration
    public PidAntiSurgeParams AntiSurgeParams { get; set; }
    Property Value
    Type Description
    PidAntiSurgeParams
    | Edit this page View Source

    FeedForward

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

    Declaration
    public PidFeedForward FeedForward { get; set; }
    Property Value
    Type Description
    PidFeedForward
    | Edit this page View Source

    Filtering

    PID-filtering object. This is optional

    Declaration
    public PidFilterParams Filtering { get; set; }
    Property Value
    Type Description
    PidFilterParams
    | Edit this page View Source

    GainScheduling

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

    Declaration
    public PidGainScheduling GainScheduling { get; set; }
    Property Value
    Type Description
    PidGainScheduling
    | Edit this page View Source

    Kp

    Proportional gain of controller

    Declaration
    public double Kp { get; set; }
    Property Value
    Type Description
    double
    | Edit this page View Source

    NanValue

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

    Declaration
    public double NanValue { get; set; }
    Property Value
    Type Description
    double
    | Edit this page View Source

    Scaling

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

    Declaration
    public PidScaling Scaling { get; set; }
    Property Value
    Type Description
    PidScaling
    | Edit this page View Source

    Td_s

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

    Declaration
    public double Td_s { get; set; }
    Property Value
    Type Description
    double
    | Edit this page View Source

    Ti_s

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

    Declaration
    public double Ti_s { get; set; }
    Property Value
    Type Description
    double
    | Edit this page View Source

    u0

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

    Declaration
    public double u0 { get; set; }
    Property Value
    Type Description
    double

    Methods

    | Edit this page View Source

    AddWarning(PidIdentWarning)

    Store a warning that arouse during identification

    Declaration
    public void AddWarning(PidIdentWarning warning)
    Parameters
    Type Name Description
    PidIdentWarning warning
    | Edit this page View Source

    GetWarnings()

    Gives any warnings that occured during identification

    Declaration
    public PidIdentWarning[] GetWarnings()
    Returns
    Type Description
    PidIdentWarning[]
    | Edit this page View Source

    ToString()

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

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX