com.interpss.dstab.controller.cml.block

Class GainBlock

java.lang.Object

com.interpss.dstab.controller.block.adapt.CMLStaticBlockAdapter

com.interpss.dstab.controller.cml.block.GainBlock

All Implemented Interfaces:

com.hazelcast.nio.serialization.DataSerializable, ICMLBlock, ICMLStaticBlock

public class GainBlock
extends CMLStaticBlockAdapter

An implementation of gain block

Nested Class Summary

Nested classes/interfaces inherited from interface com.interpss.dstab.controller.block.ICMLStaticBlock

ICMLStaticBlock.StaticBlockType

Field Summary

Fields inherited from class com.interpss.dstab.controller.block.adapt.CMLStaticBlockAdapter

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
GainBlock() constructor
GainBlock(double k) constructor
GainBlock(ICMLStaticBlock.StaticBlockType type, double k, double max, double min) constructor

Method Summary

Modifier and Type	Method and Description
void	eulerStep1(double u, double dt) Perform Euler step-1 calculation
void	eulerStep2(double u, double dt) Perform Euler step-2 calculation
double	getK() get parameter kp
LimitType	getLimit() get the limit object
double	getU0() get the controller initial input u0, it should be always called after the intiState() call.
double	getU0(double y0) get the controller initial input u0, it should be always called after the intiState() call.
double	getY() get the controller output
boolean	initStateU0(double u0) Initial the controller state variables
boolean	initStateY0(double y0) Initial the controller state variables
java.lang.String	toString()

Methods inherited from class com.interpss.dstab.controller.block.adapt.CMLStaticBlockAdapter

debugInfo, getState, getType, getU, readData, setParameter, setType, writeData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GainBlock

public GainBlock()

constructor

GainBlock

public GainBlock(double k)

constructor

Parameters:

k -

GainBlock

public GainBlock(ICMLStaticBlock.StaticBlockType type,
                 double k,
                 double max,
                 double min)

constructor

Parameters:

type -

k -

max -

min -

Method Detail

initStateY0

public boolean initStateY0(double y0)

Description copied from interface: ICMLStaticBlock

Initial the controller state variables

Specified by:

initStateY0 in interface ICMLStaticBlock

Overrides:

initStateY0 in class CMLStaticBlockAdapter

Parameters:

y0 - output initial value.

initStateU0

public boolean initStateU0(double u0)

Description copied from interface: ICMLStaticBlock

Initial the controller state variables

Specified by:

initStateU0 in interface ICMLStaticBlock

Overrides:

initStateU0 in class CMLStaticBlockAdapter

Parameters:

u0 - input initial value.

getU0

public double getU0(double y0)

Description copied from interface: ICMLStaticBlock

get the controller initial input u0, it should be always called after the intiState() call.

Specified by:

getU0 in interface ICMLStaticBlock

Overrides:

getU0 in class CMLStaticBlockAdapter

Returns:

the inout variable u initial value

getU0

public double getU0()

Description copied from interface: ICMLStaticBlock

get the controller initial input u0, it should be always called after the intiState() call.

Specified by:

getU0 in interface ICMLStaticBlock

Overrides:

getU0 in class CMLStaticBlockAdapter

Returns:

the inout variable u initial value

eulerStep1

public void eulerStep1(double u,
                       double dt)

Description copied from interface: ICMLStaticBlock

Perform Euler step-1 calculation

Specified by:

eulerStep1 in interface ICMLStaticBlock

Overrides:

eulerStep1 in class CMLStaticBlockAdapter

Parameters:

u - the input variable

dt - the time step

eulerStep2

public void eulerStep2(double u,
                       double dt)

Description copied from interface: ICMLStaticBlock

Perform Euler step-2 calculation

Specified by:

eulerStep2 in interface ICMLStaticBlock

Overrides:

eulerStep2 in class CMLStaticBlockAdapter

Parameters:

u - the input variable

dt - the time step

getY

public double getY()

Description copied from interface: ICMLStaticBlock

get the controller output

Specified by:

getY in interface ICMLStaticBlock

Overrides:

getY in class CMLStaticBlockAdapter

Returns:

the output variable y

getK

public double getK()

get parameter kp

Returns:

the kp

getLimit

public LimitType getLimit()

get the limit object

Returns:

the limit

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object