e2 docs custom stcontrol - wiremod/wire GitHub Wiki
Custom/stcontrol
Stcontrol = noStControl()
Returns invalid state control object (1 ops)
Stcontrol = newStControl()
Returns state control object with dynamic sampling time (20 ops)
Stcontrol = newStControl( Nto)
Returns state control object with static sampling time (20 ops)
Stcontrol = Stcontrol:getCopy()
Returns state control object copy instance (20 ops)
Stcontrol = Stcontrol:getCopy( Nt)
Returns state control object copy instance with static sampling time (20 ops)
Stcontrol = Stcontrol:setGainP( Np)
Updates state control proportional term gain (7 ops)
Stcontrol = Stcontrol:setGainI( Ni)
Updates state control integral term gain (7 ops)
Stcontrol = Stcontrol:setGainD( Nd)
Updates state control derivative term gain (7 ops)
Stcontrol = Stcontrol:setGainPI( Np, Ni)
Updates state control proportional term gain and integral term gain (7 ops)
Stcontrol = Stcontrol:setGainPI( Vv)
Updates state control proportional term gain and integral term gain (7 ops)
Stcontrol = Stcontrol:setGainPI( Aa)
Updates state control proportional term gain and integral term gain (7 ops)
Stcontrol = Stcontrol:setGainPD( Np, Nd)
Updates state control proportional term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGainPD( Vv)
Updates state control proportional term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGainPD( Aa)
Updates state control proportional term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGainID( Ni, Nd)
Updates state control integral term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGainID( Vv)
Updates state control derivative term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGainID( Aa)
Updates state control integral term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGain( Np, Ni, Nd)
Updates state control proportional term gain, integral term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGain( Aa)
Updates state control proportional term gain, integral term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:setGain( Vv)
Updates state control proportional term gain, integral term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:remGainP()
Removes state control proportional term gain (7 ops)
Stcontrol = Stcontrol:remGainI()
Removes state control integral term gain (7 ops)
Stcontrol = Stcontrol:remGainD()
Removes state control derivative term gain (7 ops)
Stcontrol = Stcontrol:remGainPI()
Removes state control proportional term gain and integral term gain (7 ops)
Stcontrol = Stcontrol:remGainPD()
Removes state control proportional term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:remGainID()
Removes state control integral term gain and derivative term gain (7 ops)
Stcontrol = Stcontrol:remGain()
Removes state control proportional term gain, integral term gain and derivative term gain (7 ops)
= Stcontrol:getGain()
Returns state control proportional term gain, integral term gain and derivative term gain (3 ops)
= Stcontrol:getGainPI()
Returns state control proportional term gain and integral term gain (3 ops)
= Stcontrol:getGainPD()
Returns state control proportional term gain and derivative term gain (3 ops)
= Stcontrol:getGainID()
Returns state control integral term gain and derivative term gain (3 ops)
= Stcontrol:getGainP()
Returns state control proportional term gain (3 ops)
= Stcontrol:getGainI()
Returns state control integral term gain (3 ops)
= Stcontrol:getGainD()
Returns state control derivative term gain (3 ops)
Stcontrol = Stcontrol:setBias( Nn)
Updates state control control bias (3 ops)
= Stcontrol:getBias()
Returns state control control bias (3 ops)
= Stcontrol:getType()
Returns state control control type (3 ops)
Stcontrol = Stcontrol:setWindup( Nd, Nu)
Updates state control windup lower bound and windup upper bound (3 ops)
Stcontrol = Stcontrol:setWindup( Aa)
Updates state control windup lower bound and windup upper bound (3 ops)
Stcontrol = Stcontrol:setWindup( Vv)
Updates state control windup lower bound and windup upper bound (3 ops)
Stcontrol = Stcontrol:setWindupD( Nd)
Updates state control windup lower bound (3 ops)
Stcontrol = Stcontrol:setWindupU( Nu)
Updates state control windup upper bound (3 ops)
Stcontrol = Stcontrol:remWindup()
Removes state control windup lower bound and windup upper bound (3 ops)
Stcontrol = Stcontrol:remWindupD()
Removes state control windup lower bound (3 ops)
Stcontrol = Stcontrol:remWindupU()
Removes state control windup upper bound (3 ops)
= Stcontrol:getWindup()
Returns state control windup lower bound and windup upper bound (3 ops)
= Stcontrol:getWindupD()
Returns state control windup lower bound (3 ops)
= Stcontrol:getWindupU()
Returns state control windup upper bound (3 ops)
Stcontrol = Stcontrol:setPowerP( Np)
Updates state control proportional term power (8 ops)
Stcontrol = Stcontrol:setPowerI( Ni)
Updates state control integral term power (8 ops)
Stcontrol = Stcontrol:setPowerD( Nd)
Updates state control derivative term power (8 ops)
Stcontrol = Stcontrol:setPowerPI( Np, Ni)
Updates state control proportional term power and integral term power (8 ops)
Stcontrol = Stcontrol:setPowerPI( Vv)
Updates state control proportional term power and integral term power (8 ops)
Stcontrol = Stcontrol:setPowerPI( Aa)
Updates state control proportional term power and integral term power (8 ops)
Stcontrol = Stcontrol:setPowerPD( Np, Nd)
Updates state control proportional term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPowerPD( Vv)
Updates state control proportional term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPowerPD( Aa)
Updates state control proportional term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPowerID( Ni, Nd)
Updates state control integral term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPowerID( Vv)
Updates state control derivative term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPowerID( Aa)
Updates state control integral term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPower( Np, Ni, Nd)
Updates state control proportional term power, integral term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPower( Aa)
Updates state control proportional term power, integral term power and derivative term power (8 ops)
Stcontrol = Stcontrol:setPower( Vv)
Updates state control proportional term power, integral term power and derivative term power (8 ops)
= Stcontrol:getPower()
Returns state control proportional term power, integral term power and derivative term power (3 ops)
= Stcontrol:getPowerP()
Returns state control proportional term power (3 ops)
= Stcontrol:getPowerI()
Returns state control integral term power (3 ops)
= Stcontrol:getPowerD()
Returns state control derivative term power (3 ops)
= Stcontrol:getPowerPI()
Returns state control proportional term power and integral term power (3 ops)
= Stcontrol:getPowerPD()
Returns state control proportional term power and derivative term power (3 ops)
= Stcontrol:getPowerID()
Returns state control integral term power and derivative term power (3 ops)
= Stcontrol:getErrorNow()
Returns state control process current error (3 ops)
= Stcontrol:getErrorOld()
Returns state control process passed error (3 ops)
= Stcontrol:getErrorDelta()
Returns state control process error delta (3 ops)
= Stcontrol:getTimeNow()
Returns state control process current time (3 ops)
= Stcontrol:getTimeOld()
Returns state control process passed time (3 ops)
= Stcontrol:getTimeDelta()
Returns state control dynamic process time delta (3 ops)
= Stcontrol:getTimeSample()
Returns state control static process time delta (3 ops)
Stcontrol = Stcontrol:setTimeSample( Nt)
Updates state control static process time delta (3 ops)
Stcontrol = Stcontrol:remTimeSample()
Removes state control static process time delta (3 ops)
= Stcontrol:getTimeBench()
Returns state control process benchmark time (3 ops)
= Stcontrol:getTimeRatio()
Returns state control process time ratio (3 ops)
Stcontrol = Stcontrol:setIsIntegral( Nn)
Updates integral enabled flag (3 ops)
= Stcontrol:isIntegral()
Checks integral enabled flag (3 ops)
Stcontrol = Stcontrol:setIsDerivative( Nn)
Updates derivative enabled flag (3 ops)
= Stcontrol:isDerivative()
Checks derivative enabled flag (3 ops)
Stcontrol = Stcontrol:setIsCombined( Nn)
Updates combined flag spreading proportional term gain across others (3 ops)
= Stcontrol:isCombined()
Checks state control combined flag spreading proportional term gain across others (3 ops)
Stcontrol = Stcontrol:setIsManual( Nn)
Updates state control manual control signal value (3 ops)
= Stcontrol:isManual()
Checks state control manual control flag (3 ops)
Stcontrol = Stcontrol:setManual( Nn)
Updates state control manual control value (3 ops)
= Stcontrol:getManual()
Returns state control manual control signal value (3 ops)
Stcontrol = Stcontrol:setIsInverted( Nn)
Updates state control inverted feedback flag of the reference and set-point (3 ops)
= Stcontrol:isInverted()
Checks state control inverted feedback flag of the reference and set-point (3 ops)
Stcontrol = Stcontrol:setIsActive( Nn)
Updates state control activated working flag (3 ops)
= Stcontrol:isActive()
Checks state control activated working flag (3 ops)
= Stcontrol:getControl()
Returns state control automated control signal signal (3 ops)
= Stcontrol:getControlTerm()
Returns state control automated control term signal (3 ops)
= Stcontrol:getControlTermP()
Returns state control proportional automated control term signal (3 ops)
= Stcontrol:getControlTermI()
Returns state control integral automated control term signal (3 ops)
= Stcontrol:getControlTermD()
Returns state control derivative automated control term signal (3 ops)
Stcontrol = Stcontrol:resState()
Resets state control automated internal parameters (3 ops)
Stcontrol = Stcontrol:setState( Nr, Ny)
Works state control automated internal parameters (20 ops)
Stcontrol = Stcontrol:tuneAutoZN( Uk, Ut)
Tunes the state control using the Ziegler-Nichols auto-oscillation method (ZN) (7 ops)
Stcontrol = Stcontrol:tuneAutoZN( Uk, Ut, Sm)
Tunes the state control using the Ziegler-Nichols auto-oscillation method with overshot option (ZN) (7 ops)
Stcontrol = Stcontrol:tuneProcZN( Uk, Ut, Ul)
Tunes the state control using the Ziegler-Nichols plant process method (ZN) (7 ops)
Stcontrol = Stcontrol:tuneProcCC( Nk, Nt, Nl)
Tunes the state control using the Choen-Coon method (CC) (7 ops)
Stcontrol = Stcontrol:tuneProcCHRSP( Nk, Nt, Nl)
Tunes the state control using the Chien-Hrones-Reswick method (CHR) set point track (7 ops)
Stcontrol = Stcontrol:tuneOverCHRSP( Nk, Nt, Nl)
Tunes the state control using the Chien-Hrones-Reswick method (CHR) set point track 20% overshot (7 ops)
Stcontrol = Stcontrol:tuneProcCHRLR( Nk, Nt, Nl)
Tunes the state control using the Chien-Hrones-Reswick method (CHR) load rejection (7 ops)
Stcontrol = Stcontrol:tuneOverCHRLR( Nk, Nt, Nl)
Tunes the state control using the Chien-Hrones-Reswick method (CHR) load rejection 20% overshot (7 ops)
Stcontrol = Stcontrol:tuneAH( Nk, Nt, Nl)
Tunes the state control using the Astrom-Hagglund method (AH) (7 ops)
Stcontrol = Stcontrol:tuneISE( Nk, Nt, Nl)
Tunes the state control using the integral square error method (ISE) (7 ops)
Stcontrol = Stcontrol:tuneIAE( Nk, Nt, Nl)
Tunes the state control using the integral absolute error method (IAE) (7 ops)
Stcontrol = Stcontrol:tuneITAE( Nk, Nt, Nl)
Tunes the state control using the integral of time-weighted absolute error method (ITAE) (7 ops)
Stcontrol = Stcontrol:dumpItem( Nn)
Dumps state control to the chat area by number identifier (15 ops)
Stcontrol = Stcontrol:dumpItem( Sn)
Dumps state control to the chat area by string identifier (15 ops)
Stcontrol = Stcontrol:dumpItem( Nt, Nn)
Dumps state control by number identifier in the specified area by first argument (15 ops)
Stcontrol = Stcontrol:dumpItem( Nt, Sn)
Dumps state control by string identifier in the specified area by first argument (15 ops)