BlackBox

Documentation of 'flanagan.control.BlackBox' Java class BlackBox

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- flanagan.control.BlackBox

Direct Known Subclasses:

AtoD, ClosedLoop, Compensator, DelayLine, DtoA, FirstOrder, HighPassPassive, LowPassPassive, OpenLoop, Prop, PropDeriv, PropInt, PropIntDeriv, SecondOrder, Transducer, ZeroOrderHold
```
public class BlackBox
extends java.lang.Object
```

Constructor Summary

Constructors
Constructor and Description

BlackBox()

BlackBox(java.lang.String name)

Constructors
Constructor and Description
`BlackBox()`
`BlackBox(java.lang.String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`BlackBox`	`copy()`
`void`	`copyBBvariables(BlackBox bb)`
`double`	`evalMagTransFunctS()`
`double`	`evalMagTransFunctS(Complex sValue)`
`double`	`evalMagTransFunctS(double freq)`
`double`	`evalMagTransFunctZ()`
`double`	`evalMagTransFunctZ(Complex zValue)`
`double`	`evalPhaseTransFunctS()`
`double`	`evalPhaseTransFunctS(Complex sValue)`
`double`	`evalPhaseTransFunctS(double freq)`
`double`	`evalPhaseTransFunctZ()`
`double`	`evalPhaseTransFunctZ(Complex zValue)`
`Complex`	`evalTransFunctS()`
`Complex`	`evalTransFunctS(Complex sValue)`
`Complex`	`evalTransFunctS(double freq)`
`Complex`	`evalTransFunctZ()`
`Complex`	`evalTransFunctZ(Complex zValue)`
`double`	`getCurrentInputT()`
`double`	`getCurrentOutputT()`
`double`	`getCurrentOutputT(double ttime, double inp)`
`double`	`getCurrentTime()`
`double`	`getDeadTime()`
`double`	`getDeltaT()`
`double`	`getForgetFactor()`
`Complex`	`getInputS()`
`double[]`	`getInputT()`
`int`	`getIntegMethod()`
`boolean`	`getMaptozero()`
`java.lang.String`	`getName()`
`int`	`getNplotPoints()`
`Complex`	`getOutputS()`
`Complex`	`getOutputS(Complex svalue, Complex inputs)`
`double[]`	`getOutputT()`
`int`	`getPadeOrder()`
`Complex[]`	`getPolesPadeS()`
`Complex[]`	`getPolesS()`
`Complex[]`	`getPolesZ()`
`Complex`	`getS()`
`double`	`getSampFreq()`
`int`	`getSampleLength()`
`ComplexPoly`	`getSdenom()`
`int`	`getSdenomDeg()`
`ComplexPoly`	`getSdenomPade()`
`int`	`getSdenomPadeDeg()`
`Complex`	`getSdenomScaleFactor()`
`double`	`getSeadyStateValue()`
`double`	`getSeadyStateValue(double mag)`
`ComplexPoly`	`getSnumer()`
`int`	`getSnumerDeg()`
`ComplexPoly`	`getSnumerPade()`
`int`	`getSnumerPadeDeg()`
`Complex`	`getSnumerScaleFactor()`
`double[]`	`getTime()`
`Complex`	`getZ()`
`ComplexPoly`	`getZdenom()`
`int`	`getZdenomDeg()`
`Complex[]`	`getZerosPadeS()`
`Complex[]`	`getZerosS()`
`Complex[]`	`getZerosZ()`
`ComplexPoly`	`getZnumer()`
`int`	`getZnumerDeg()`
`int`	`getZtransformMethod()`
`void`	`impulseInput(double finalTime)`
`void`	`impulseInput(double impulseMag, double finalTime)`
`static Complex[][]`	`inverseTransform(ComplexPoly numer, ComplexPoly denom)`
`static Complex[][]`	`inverseTransform(ComplexPoly numer, ComplexPoly denom, Complex magNumer, Complex magDenom)`
`static double[][]`	`inverseTransformToReal(ComplexPoly numer, ComplexPoly denom)`
`void`	`mapstozAdHoc()`
`void`	`mapstozAdHoc(double deltaT)`
`int`	`orderPade()`
`void`	`plotBode(double lowFreq, double highFreq)`
`void`	`plotPoleZeroPadeS()`
`void`	`plotPoleZeroS()`
`void`	`plotPoleZeroZ()`
`void`	`rampInput(double finalTime)`
`void`	`rampInput(double rampGradient, double finalTime)`
`void`	`rampInput(double rampGradient, int rampOrder, double finalTime)`
`void`	`rampInput(int rampOrder, double finalTime)`
`void`	`resetZero()`
`static Complex`	`scaleFactor(ComplexPoly poly, Complex[] roots)`
`void`	`setDeadTime(double deadtime)`
`void`	`setDeadTime(double deadtime, int orderPade)`
`void`	`setDeltaT(double deltaT)`
`void`	`setForgetFactor(double forget)`
`void`	`setInputS(Complex input)`
`void`	`setInputT(double[] ttime, double[] inputt)`
`void`	`setInputT(double ttime, double inputt)`
`void`	`setIntegrateOption(int integMethod)`
`void`	`setIntegrateOption(java.lang.String integMethodS)`
`void`	`setMaptozero(boolean maptozero)`
`void`	`setName(java.lang.String name)`
`void`	`setNplotPoints(int nPoints)`
`void`	`setPadeOrder(int orderPade)`
`void`	`setS(Complex s)`
`void`	`setS(double si)`
`void`	`setS(double sr, double si)`
`void`	`setSampFreq(double sfreq)`
`void`	`setSampleLength(int samplen)`
`void`	`setSdenom(Complex[] coeff)`
`void`	`setSdenom(ComplexPoly coeff)`
`void`	`setSdenom(double[] coeff)`
`void`	`setSnumer(Complex[] coeff)`
`void`	`setSnumer(ComplexPoly coeff)`
`void`	`setSnumer(double[] coeff)`
`void`	`setZ(Complex z)`
`void`	`setZ(double zr, double zi)`
`void`	`setZdenom(Complex[] coeff)`
`void`	`setZdenom(ComplexPoly coeff)`
`void`	`setZdenom(double[] coeff)`
`void`	`setZnumer(Complex[] coeff)`
`void`	`setZnumer(ComplexPoly coeff)`
`void`	`setZnumer(double[] coeff)`
`void`	`setZtransformMethod(int ztransMethod)`
`void`	`stepInput(double finalTime)`
`void`	`stepInput(double stepMag, double finalTime)`
`static Complex`	`timeTerm(double ttime, Complex coeff, Complex constant, Complex power)`
`static double`	`timeTerm(double ttime, double coeff, double constant, double power)`
`static double`	`timeTerm(double ttime, double coeff, double constant, int power)`
`static void`	`transientResponse(int nPoints, double finalTime, double deadTime, ComplexPoly numerT, ComplexPoly denomT, java.lang.String graphtitle1, java.lang.String graphtitle2)`
`static void`	`transientResponse(int nPoints, double finalTime, double deadTime, ComplexPoly numerT, ComplexPoly denomT, java.lang.String graphtitle1, java.lang.String graphtitle2, Complex magN, Complex magD)`
`void`	`zTransform()`
`void`	`zTransform(double deltat)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlackBox
```
public BlackBox()
```

BlackBox

public BlackBox(java.lang.String name)

Method Detail

setSnumer

public void setSnumer(double[] coeff)

setSnumer

public void setSnumer(Complex[] coeff)

setSnumer

public void setSnumer(ComplexPoly coeff)

setSdenom

public void setSdenom(double[] coeff)

setSdenom

public void setSdenom(Complex[] coeff)

setSdenom

public void setSdenom(ComplexPoly coeff)

scaleFactor

public static Complex scaleFactor(ComplexPoly poly,
                                  Complex[] roots)

getSnumerScaleFactor
```
public Complex getSnumerScaleFactor()
```

getSdenomScaleFactor
```
public Complex getSdenomScaleFactor()
```

setDeadTime

public void setDeadTime(double deadtime)

setDeadTime

public void setDeadTime(double deadtime,
                        int orderPade)

setPadeOrder

public void setPadeOrder(int orderPade)

getDeadTime
```
public double getDeadTime()
```

getPadeOrder
```
public int getPadeOrder()
```

orderPade
```
public int orderPade()
```

zTransform

public void zTransform(double deltat)

zTransform
```
public void zTransform()
```

mapstozAdHoc

public void mapstozAdHoc(double deltaT)

mapstozAdHoc
```
public void mapstozAdHoc()
```

setMaptozero

public void setMaptozero(boolean maptozero)

setZnumer

public void setZnumer(double[] coeff)

setZnumer

public void setZnumer(Complex[] coeff)

setZnumer

public void setZnumer(ComplexPoly coeff)

setZdenom

public void setZdenom(double[] coeff)

setZdenom

public void setZdenom(Complex[] coeff)

setZdenom

public void setZdenom(ComplexPoly coeff)

setDeltaT
```
public void setDeltaT(double deltaT)
```

setForgetFactor

public void setForgetFactor(double forget)

setSampFreq

public void setSampFreq(double sfreq)

setS
```
public void setS(Complex s)
```

setS

public void setS(double sr,
                 double si)

setS
```
public void setS(double si)
```

setZ
```
public void setZ(Complex z)
```

setZ

public void setZ(double zr,
                 double zi)

setZtransformMethod

public void setZtransformMethod(int ztransMethod)

setIntegrateOption

public void setIntegrateOption(int integMethod)

setIntegrateOption

public void setIntegrateOption(java.lang.String integMethodS)

setSampleLength

public void setSampleLength(int samplen)

setName

public void setName(java.lang.String name)

setInputT

public void setInputT(double ttime,
                      double inputt)

setInputT

public void setInputT(double[] ttime,
                      double[] inputt)

setInputS
```
public void setInputS(Complex input)
```

resetZero
```
public void resetZero()
```

getSeadyStateValue
```
public double getSeadyStateValue()
```

getSeadyStateValue

public double getSeadyStateValue(double mag)

evalTransFunctS
```
public Complex evalTransFunctS()
```

evalTransFunctS

public Complex evalTransFunctS(Complex sValue)

evalTransFunctS

public Complex evalTransFunctS(double freq)

evalMagTransFunctS
```
public double evalMagTransFunctS()
```

evalMagTransFunctS

public double evalMagTransFunctS(Complex sValue)

evalMagTransFunctS

public double evalMagTransFunctS(double freq)

evalPhaseTransFunctS
```
public double evalPhaseTransFunctS()
```

evalPhaseTransFunctS

public double evalPhaseTransFunctS(Complex sValue)

evalPhaseTransFunctS

public double evalPhaseTransFunctS(double freq)

evalTransFunctZ
```
public Complex evalTransFunctZ()
```

evalTransFunctZ

public Complex evalTransFunctZ(Complex zValue)

evalMagTransFunctZ
```
public double evalMagTransFunctZ()
```

evalMagTransFunctZ

public double evalMagTransFunctZ(Complex zValue)

evalPhaseTransFunctZ
```
public double evalPhaseTransFunctZ()
```

evalPhaseTransFunctZ

public double evalPhaseTransFunctZ(Complex zValue)

getIntegMethod
```
public int getIntegMethod()
```

getZtransformMethod
```
public int getZtransformMethod()
```

getSampleLength
```
public int getSampleLength()
```

getForgetFactor
```
public double getForgetFactor()
```

getCurrentTime
```
public double getCurrentTime()
```

getTime
```
public double[] getTime()
```

getCurrentInputT
```
public double getCurrentInputT()
```

getInputT
```
public double[] getInputT()
```

getInputS
```
public Complex getInputS()
```

getDeltaT
```
public double getDeltaT()
```

getSampFreq
```
public double getSampFreq()
```

getS
```
public Complex getS()
```

getZ
```
public Complex getZ()
```

getSnumerDeg
```
public int getSnumerDeg()
```

getSnumerPadeDeg
```
public int getSnumerPadeDeg()
```

getSdenomDeg
```
public int getSdenomDeg()
```

getSdenomPadeDeg
```
public int getSdenomPadeDeg()
```

getSnumer
```
public ComplexPoly getSnumer()
```

getSnumerPade
```
public ComplexPoly getSnumerPade()
```

getSdenom
```
public ComplexPoly getSdenom()
```

getSdenomPade
```
public ComplexPoly getSdenomPade()
```

getZnumerDeg
```
public int getZnumerDeg()
```

getZdenomDeg
```
public int getZdenomDeg()
```

getZnumer
```
public ComplexPoly getZnumer()
```

getZdenom
```
public ComplexPoly getZdenom()
```

getZerosS
```
public Complex[] getZerosS()
```

getZerosPadeS
```
public Complex[] getZerosPadeS()
```

getPolesS
```
public Complex[] getPolesS()
```

getPolesPadeS
```
public Complex[] getPolesPadeS()
```

getZerosZ
```
public Complex[] getZerosZ()
```

getPolesZ
```
public Complex[] getPolesZ()
```

getMaptozero
```
public boolean getMaptozero()
```

getName
```
public java.lang.String getName()
```

plotPoleZeroS
```
public void plotPoleZeroS()
```

plotPoleZeroPadeS
```
public void plotPoleZeroPadeS()
```

plotPoleZeroZ
```
public void plotPoleZeroZ()
```

plotBode

public void plotBode(double lowFreq,
                     double highFreq)

getCurrentOutputT

public double getCurrentOutputT(double ttime,
                                double inp)

getCurrentOutputT
```
public double getCurrentOutputT()
```

getOutputT
```
public double[] getOutputT()
```

getOutputS
```
public Complex getOutputS()
```

getOutputS

public Complex getOutputS(Complex svalue,
                          Complex inputs)

setNplotPoints

public void setNplotPoints(int nPoints)

getNplotPoints
```
public int getNplotPoints()
```

impulseInput

public void impulseInput(double impulseMag,
                         double finalTime)

impulseInput

public void impulseInput(double finalTime)

stepInput

public void stepInput(double stepMag,
                      double finalTime)

stepInput

public void stepInput(double finalTime)

rampInput

public void rampInput(double rampGradient,
                      int rampOrder,
                      double finalTime)

rampInput

public void rampInput(int rampOrder,
                      double finalTime)

rampInput

public void rampInput(double rampGradient,
                      double finalTime)

rampInput

public void rampInput(double finalTime)

transientResponse

public static void transientResponse(int nPoints,
                                     double finalTime,
                                     double deadTime,
                                     ComplexPoly numerT,
                                     ComplexPoly denomT,
                                     java.lang.String graphtitle1,
                                     java.lang.String graphtitle2)

transientResponse

public static void transientResponse(int nPoints,
                                     double finalTime,
                                     double deadTime,
                                     ComplexPoly numerT,
                                     ComplexPoly denomT,
                                     java.lang.String graphtitle1,
                                     java.lang.String graphtitle2,
                                     Complex magN,
                                     Complex magD)

timeTerm

public static Complex timeTerm(double ttime,
                               Complex coeff,
                               Complex constant,
                               Complex power)

timeTerm

public static double timeTerm(double ttime,
                              double coeff,
                              double constant,
                              int power)

timeTerm

public static double timeTerm(double ttime,
                              double coeff,
                              double constant,
                              double power)

inverseTransformToReal

public static double[][] inverseTransformToReal(ComplexPoly numer,
                                                ComplexPoly denom)

inverseTransform

public static Complex[][] inverseTransform(ComplexPoly numer,
                                           ComplexPoly denom)

inverseTransform

public static Complex[][] inverseTransform(ComplexPoly numer,
                                           ComplexPoly denom,
                                           Complex magNumer,
                                           Complex magDenom)

copy
```
public BlackBox copy()
```

copyBBvariables

public void copyBBvariables(BlackBox bb)

clone
```
public java.lang.Object clone()
```
Overrides:

clone in class java.lang.Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class BlackBox

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BlackBox

BlackBox

Method Detail

setSnumer

setSnumer

setSnumer

setSdenom

setSdenom

setSdenom

scaleFactor

getSnumerScaleFactor

getSdenomScaleFactor

setDeadTime

setDeadTime

setPadeOrder

getDeadTime

getPadeOrder

orderPade

zTransform

zTransform

mapstozAdHoc

mapstozAdHoc

setMaptozero

setZnumer

setZnumer

setZnumer

setZdenom

setZdenom

setZdenom

setDeltaT

setForgetFactor

setSampFreq

setS

setS

setS

setZ

setZ

setZtransformMethod

setIntegrateOption

setIntegrateOption

setSampleLength

setName

setInputT

setInputT

setInputS

resetZero

getSeadyStateValue

getSeadyStateValue

evalTransFunctS

evalTransFunctS

evalTransFunctS

evalMagTransFunctS

evalMagTransFunctS

evalMagTransFunctS

evalPhaseTransFunctS

evalPhaseTransFunctS

evalPhaseTransFunctS

evalTransFunctZ

evalTransFunctZ

evalMagTransFunctZ

evalMagTransFunctZ

evalPhaseTransFunctZ

evalPhaseTransFunctZ

getIntegMethod

getZtransformMethod

getSampleLength

getForgetFactor

getCurrentTime

getTime

getCurrentInputT

getInputT

getInputS

getDeltaT

getSampFreq

getS