Version: 13.0

    Show / Hide Table of Contents

    Class PIDControlSettings

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    PIDControlSettings
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.cacheRpds
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, (T1, T2)<Type, Object>[])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T1, T2>(String, (T1, T2)<Type, Object>, T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.isInvalid
    APIBase.DocumentationUrl()
    APIBase.ToString()
    APIBase.RunPython<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String)
    APIBase.RunPython<T>(String, String)
    APIBase.CreateObjRef(Type)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
    Namespace: SMT.MastaAPI.MathUtility.Control
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class PIDControlSettings : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    ControlStartTime

    Measurement: TimeShort

    Declaration
    public double ControlStartTime { get; set; }
    Property Value
    Type Description
    System.Double

    DifferentialGain

    Declaration
    public double DifferentialGain { get; set; }
    Property Value
    Type Description
    System.Double

    DifferentialGainVsTimeAndError

    Declaration
    public GriddedSurfaceAccessor DifferentialGainVsTimeAndError { get; set; }
    Property Value
    Type Description
    GriddedSurfaceAccessor

    DifferentialTimeConstant

    Measurement: TimeShort

    Declaration
    public double DifferentialTimeConstant { get; }
    Property Value
    Type Description
    System.Double

    IntegralGain

    Declaration
    public double IntegralGain { get; set; }
    Property Value
    Type Description
    System.Double

    IntegralGainVsTimeAndError

    Declaration
    public GriddedSurfaceAccessor IntegralGainVsTimeAndError { get; set; }
    Property Value
    Type Description
    GriddedSurfaceAccessor

    IntegralTimeConstant

    Measurement: TimeShort

    Declaration
    public double IntegralTimeConstant { get; }
    Property Value
    Type Description
    System.Double

    MaxChangeInManipulatedValuePerUnitTime

    Limits the rate of change of the result in time.

    Declaration
    public double MaxChangeInManipulatedValuePerUnitTime { get; set; }
    Property Value
    Type Description
    System.Double

    MaxManipulatedValue

    Upper limit on the resulting value

    Declaration
    public double MaxManipulatedValue { get; set; }
    Property Value
    Type Description
    System.Double

    MinManipulatedValue

    Lower limit on the resulting value

    Declaration
    public double MinManipulatedValue { get; set; }
    Property Value
    Type Description
    System.Double

    PIDCalculatesChangeInManipulatedValue

    If this option is selected, then the gain values applied to the error result in the change in the manipulated value. Otherwise the gain values applied to the error result in the actual manipulated value.

    Declaration
    public bool PIDCalculatesChangeInManipulatedValue { get; set; }
    Property Value
    Type Description
    System.Boolean

    ProportionalGain

    Declaration
    public double ProportionalGain { get; set; }
    Property Value
    Type Description
    System.Double

    ProportionalGainVsTimeAndError

    Declaration
    public GriddedSurfaceAccessor ProportionalGainVsTimeAndError { get; set; }
    Property Value
    Type Description
    GriddedSurfaceAccessor

    SetPointValue

    Declaration
    public double SetPointValue { get; set; }
    Property Value
    Type Description
    System.Double

    UpdateFrequency

    Measurement: Frequency

    Declaration
    public double UpdateFrequency { get; set; }
    Property Value
    Type Description
    System.Double

    UpdateMethod

    Declaration
    public PIDControlUpdateMethod UpdateMethod { get; set; }
    Property Value
    Type Description
    PIDControlUpdateMethod

    UpdateTime

    Measurement: TimeVeryShort

    Declaration
    public double UpdateTime { get; set; }
    Property Value
    Type Description
    System.Double

    UseDifferentialGainScheduling

    Declaration
    public bool UseDifferentialGainScheduling { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseIntegralGainScheduling

    Declaration
    public bool UseIntegralGainScheduling { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseIntegratorAntiWindup

    Declaration
    public bool UseIntegratorAntiWindup { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseProportionalGainScheduling

    Declaration
    public bool UseProportionalGainScheduling { get; set; }
    Property Value
    Type Description
    System.Boolean

    Implements

    System.IEquatable<T>

    Extension Methods

    UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)
    UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)
    Back to top