org.jscience.engineering.control
Class FirstOrder

java.lang.Object
  org.jscience.engineering.control.BlackBox
      org.jscience.engineering.control.FirstOrder

public class FirstOrder
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

FirstOrder()
Creates a new FirstOrder object.

FirstOrder(double aa, double bb, double cc)
Creates a new FirstOrder object.

Method Summary

void	calcOutputT() DOCUMENT ME!
void	calcOutputT(double ttime, double inp) DOCUMENT ME!
protected void	calcPolesZerosS() DOCUMENT ME!
double	getA() DOCUMENT ME!
double	getB() DOCUMENT ME!
double	getC() DOCUMENT ME!
Complex	getOutputS() DOCUMENT ME!
Complex	getOutputS(Complex sValue, Complex iinput) DOCUMENT ME!
Complex[]	getSzeros() DOCUMENT ME!
double	getTimeConstant() DOCUMENT ME!
void	setA(double aa) DOCUMENT ME!
void	setB(double bb) DOCUMENT ME!
void	setC(double cc) DOCUMENT ME!
void	setCoeff(double aa, double bb, double cc) 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	zTransform() DOCUMENT ME!
void	zTransform(double deltaT) DOCUMENT ME!

Methods inherited from class org.jscience.engineering.control.BlackBox

addDeadTimeExtras, 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, getPolesS, getPolesZ, getS, getSampFreq, getSampleLength, getSdenom, getSdenomDeg, getSnumer, getSnumerDeg, getTime, getZ, getZdenom, getZdenomDeg, getZerosS, getZerosZ, getZnumer, getZnumerDeg, getZtransformMethod, impulseInput, impulseInput, inverseTransform, mapstozAdHoc, mapstozAdHoc, orderPade, pade, plotBode, plotPoleZeroS, plotPoleZeroZ, rampInput, rampInput, rampInput, rampInput, resetZero, setDeadTime, setDeadTime, setDeltaT, setForgetFactor, setInputS, setInputT, setIntegrateOption, setIntegrateOption, setMaptozero, setName, setNplotPoints, setPadeOrder, setS, setS, setS, setSampFreq, setSampleLength, setZ, setZ, setZtransformMethod, stepInput, stepInput, timeTerm, transferPolesZeros, transientResponse, zeroPoleCancellation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FirstOrder

public FirstOrder()

Creates a new FirstOrder object.

FirstOrder

public FirstOrder(double aa,
                  double bb,
                  double cc)

Creates a new FirstOrder object.

Parameters:

aa - DOCUMENT ME!

bb - DOCUMENT ME!

cc - DOCUMENT ME!

Method Detail

setCoeff

public void setCoeff(double aa,
                     double bb,
                     double cc)

DOCUMENT ME!

Parameters:

aa - DOCUMENT ME!

bb - DOCUMENT ME!

cc - DOCUMENT ME!

setA

public void setA(double aa)

DOCUMENT ME!

Parameters:

aa - DOCUMENT ME!

setB

public void setB(double bb)

DOCUMENT ME!

Parameters:

bb - DOCUMENT ME!

setC

public void setC(double cc)

DOCUMENT ME!

Parameters:

cc - DOCUMENT ME!

getA

public double getA()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getB

public double getB()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getC

public double getC()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getTimeConstant

public double getTimeConstant()

DOCUMENT ME!

Returns:

DOCUMENT ME!

calcPolesZerosS

protected void calcPolesZerosS()

DOCUMENT ME!

Overrides:

calcPolesZerosS in class BlackBox

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!

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!

getSzeros

public Complex[] getSzeros()

DOCUMENT ME!

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!