org.jscience.engineering.control
Class Prop

java.lang.Object
  extended by org.jscience.engineering.control.BlackBox
      extended by org.jscience.engineering.control.Prop

public class Prop
extends BlackBox

DOCUMENT ME!


Field Summary
 
Fields inherited from class org.jscience.engineering.control.BlackBox
deadTime, deltaT, fixedName, forgetFactor, inputS, inputT, integMethod, integrationSum, maptozero, name, nPlotPoints, orderPade, outputS, outputT, padeAdded, sampFreq, sampLen, sDenom, sDenomDeg, sDenomDegPade, sDenomPade, sNumer, sNumerDeg, sNumerDegPade, sNumerPade, sPoles, sPolesPade, sValue, sZeros, sZerosPade, time, zDenom, zDenomDeg, zNumer, zNumerDeg, zPoles, ztransMethod, zValue, zZeros
 
Constructor Summary
Prop()
          Creates a new Prop object.
Prop(double kp)
          Creates a new Prop object.
 
Method Summary
 void calcOutputT()
          DOCUMENT ME!
 void calcOutputT(double ttime, double inp)
          DOCUMENT ME!
 double getKp()
          DOCUMENT ME!
 Complex getOutputS()
          DOCUMENT ME!
 Complex getOutputS(Complex sValue, Complex iinput)
          DOCUMENT ME!
 Complex[] getPolesS()
          DOCUMENT ME!
 Complex[] getZerosS()
          DOCUMENT ME!
 void rampInput(double finalTime)
          DOCUMENT ME!
 void rampInput(double rampGradient, double finalTime)
          DOCUMENT ME!
 void rampInput(double rampGradient, int rampOrder, double finalTime)
          DOCUMENT ME!
 void rampInput(int rampOrder, double finalTime)
          DOCUMENT ME!
 void setKp(double kp)
          DOCUMENT ME!
 void setSdenom(Complex[] coeff)
          DOCUMENT ME!
 void setSdenom(ComplexPolynomial coeff)
          DOCUMENT ME!
 void setSdenom(double[] coeff)
          DOCUMENT ME!
 void setSnumer(Complex[] coeff)
          DOCUMENT ME!
 void setSnumer(ComplexPolynomial coeff)
          DOCUMENT ME!
 void setSnumer(double[] coeff)
          DOCUMENT ME!
 void setZdenom(Complex[] coeff)
          DOCUMENT ME!
 void setZdenom(ComplexPolynomial coeff)
          DOCUMENT ME!
 void setZdenom(double[] coeff)
          DOCUMENT ME!
 void setZnumer(Complex[] coeff)
          DOCUMENT ME!
 void setZnumer(ComplexPolynomial coeff)
          DOCUMENT ME!
 void setZnumer(double[] coeff)
          DOCUMENT ME!
 void stepInput(double finalTime)
          DOCUMENT ME!
 void stepInput(double stepMag, double finalTime)
          DOCUMENT ME!
 void zTransform()
          DOCUMENT ME!
 void zTransform(double deltaT)
          DOCUMENT ME!
 
Methods inherited from class org.jscience.engineering.control.BlackBox
addDeadTimeExtras, calcPolesZerosS, deadTimeWarning, evalMagTransFunctS, evalMagTransFunctS, evalMagTransFunctS, evalMagTransFunctZ, evalMagTransFunctZ, evalPhaseTransFunctS, evalPhaseTransFunctS, evalPhaseTransFunctS, evalPhaseTransFunctZ, evalPhaseTransFunctZ, evalTransFunctS, evalTransFunctS, evalTransFunctS, evalTransFunctZ, evalTransFunctZ, getCurrentInputT, getCurrentOutputT, getCurrentOutputT, getCurrentTime, getDeadTime, getDeltaT, getForgetFactor, getInputS, getInputT, getIntegMethod, getMaptozero, getName, getNplotPoints, getOutputT, getPadeOrder, getPolesZ, getS, getSampFreq, getSampleLength, getSdenom, getSdenomDeg, getSnumer, getSnumerDeg, getTime, getZ, getZdenom, getZdenomDeg, getZerosZ, getZnumer, getZnumerDeg, getZtransformMethod, impulseInput, impulseInput, inverseTransform, mapstozAdHoc, mapstozAdHoc, orderPade, pade, plotBode, plotPoleZeroS, plotPoleZeroZ, resetZero, setDeadTime, setDeadTime, setDeltaT, setForgetFactor, setInputS, setInputT, setIntegrateOption, setIntegrateOption, setMaptozero, setName, setNplotPoints, setPadeOrder, setS, setS, setS, setSampFreq, setSampleLength, setZ, setZ, setZtransformMethod, timeTerm, transferPolesZeros, transientResponse, zeroPoleCancellation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Prop

public Prop()
Creates a new Prop object.


Prop

public Prop(double kp)
Creates a new Prop object.

Parameters:
kp - DOCUMENT ME!
Method Detail

setKp

public void setKp(double kp)
DOCUMENT ME!

Parameters:
kp - DOCUMENT ME!

getKp

public double getKp()
DOCUMENT ME!

Returns:
DOCUMENT ME!

zTransform

public void zTransform()
DOCUMENT ME!

Overrides:
zTransform in class BlackBox

zTransform

public void zTransform(double deltaT)
DOCUMENT ME!

Overrides:
zTransform in class BlackBox
Parameters:
deltaT - DOCUMENT ME!

stepInput

public void stepInput(double stepMag,
                      double finalTime)
DOCUMENT ME!

Overrides:
stepInput in class BlackBox
Parameters:
stepMag - DOCUMENT ME!
finalTime - DOCUMENT ME!

stepInput

public void stepInput(double finalTime)
DOCUMENT ME!

Overrides:
stepInput in class BlackBox
Parameters:
finalTime - DOCUMENT ME!

rampInput

public void rampInput(double rampGradient,
                      int rampOrder,
                      double finalTime)
DOCUMENT ME!

Overrides:
rampInput in class BlackBox
Parameters:
rampGradient - DOCUMENT ME!
rampOrder - DOCUMENT ME!
finalTime - DOCUMENT ME!

rampInput

public void rampInput(int rampOrder,
                      double finalTime)
DOCUMENT ME!

Overrides:
rampInput in class BlackBox
Parameters:
rampOrder - DOCUMENT ME!
finalTime - DOCUMENT ME!

rampInput

public void rampInput(double rampGradient,
                      double finalTime)
DOCUMENT ME!

Overrides:
rampInput in class BlackBox
Parameters:
rampGradient - DOCUMENT ME!
finalTime - DOCUMENT ME!

rampInput

public void rampInput(double finalTime)
DOCUMENT ME!

Overrides:
rampInput in class BlackBox
Parameters:
finalTime - DOCUMENT ME!

getOutputS

public Complex getOutputS(Complex sValue,
                          Complex iinput)
DOCUMENT ME!

Overrides:
getOutputS in class BlackBox
Parameters:
sValue - DOCUMENT ME!
iinput - DOCUMENT ME!
Returns:
DOCUMENT ME!

getOutputS

public Complex getOutputS()
DOCUMENT ME!

Overrides:
getOutputS in class BlackBox
Returns:
DOCUMENT ME!

calcOutputT

public void calcOutputT(double ttime,
                        double inp)
DOCUMENT ME!

Parameters:
ttime - DOCUMENT ME!
inp - DOCUMENT ME!

calcOutputT

public void calcOutputT()
DOCUMENT ME!


getZerosS

public Complex[] getZerosS()
DOCUMENT ME!

Overrides:
getZerosS in class BlackBox
Returns:
DOCUMENT ME!

getPolesS

public Complex[] getPolesS()
DOCUMENT ME!

Overrides:
getPolesS in class BlackBox
Returns:
DOCUMENT ME!

setSnumer

public void setSnumer(double[] coeff)
DOCUMENT ME!

Overrides:
setSnumer in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setSnumer

public void setSnumer(Complex[] coeff)
DOCUMENT ME!

Overrides:
setSnumer in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setSnumer

public void setSnumer(ComplexPolynomial coeff)
DOCUMENT ME!

Overrides:
setSnumer in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setSdenom

public void setSdenom(double[] coeff)
DOCUMENT ME!

Overrides:
setSdenom in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setSdenom

public void setSdenom(Complex[] coeff)
DOCUMENT ME!

Overrides:
setSdenom in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setSdenom

public void setSdenom(ComplexPolynomial coeff)
DOCUMENT ME!

Overrides:
setSdenom in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setZnumer

public void setZnumer(double[] coeff)
DOCUMENT ME!

Overrides:
setZnumer in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setZnumer

public void setZnumer(Complex[] coeff)
DOCUMENT ME!

Overrides:
setZnumer in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setZnumer

public void setZnumer(ComplexPolynomial coeff)
DOCUMENT ME!

Overrides:
setZnumer in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setZdenom

public void setZdenom(double[] coeff)
DOCUMENT ME!

Overrides:
setZdenom in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setZdenom

public void setZdenom(Complex[] coeff)
DOCUMENT ME!

Overrides:
setZdenom in class BlackBox
Parameters:
coeff - DOCUMENT ME!

setZdenom

public void setZdenom(ComplexPolynomial coeff)
DOCUMENT ME!

Overrides:
setZdenom in class BlackBox
Parameters:
coeff - DOCUMENT ME!