com.interpss.dstab.controller.annotate

Class AbstractAnnotateController

java.lang.Object

org.eclipse.emf.common.notify.impl.BasicNotifierImpl

org.eclipse.emf.ecore.impl.BasicEObjectImpl

org.eclipse.emf.ecore.impl.EObjectImpl

com.interpss.core.net.impl.NameTagImpl

com.interpss.dstab.device.impl.DynamicDeviceImpl

com.interpss.dstab.mach.impl.MachineControllerImpl

com.interpss.dstab.controller.annotate.AbstractAnnotateController

All Implemented Interfaces:

com.hazelcast.nio.serialization.DataSerializable, NameTag, IDynamicSimulation, DynamicDevice, MachineController, org.eclipse.emf.common.notify.Notifier, org.eclipse.emf.ecore.EObject, org.eclipse.emf.ecore.InternalEObject

Direct Known Subclasses:

AbstractChildAnnotateController, AnnotateExciter, AnnotateGovernor, AnnotateStabilizer

public abstract class AbstractAnnotateController
extends MachineControllerImpl

Base class for all annotated CML controller - the fieldWrapperList contains a list of CML field annotation wrapper. The actual simulation is delegated to the CML filed, which is represented by a controller block, such as a DelayControlBlock - it could be child controller, represented as a CML field

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl

org.eclipse.emf.common.notify.impl.BasicNotifierImpl.EAdapterList<E extends java.lang.Object & org.eclipse.emf.common.notify.Adapter>, org.eclipse.emf.common.notify.impl.BasicNotifierImpl.EObservableAdapterList

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.InternalEObject

org.eclipse.emf.ecore.InternalEObject.EStore

Field Summary

Fields inherited from class org.eclipse.emf.ecore.impl.EObjectImpl

ELAST_EOBJECT_FLAG

Fields inherited from interface org.eclipse.emf.ecore.InternalEObject

EOPPOSITE_FEATURE_BASE

Constructor Summary

Constructors

Constructor and Description
AbstractAnnotateController() constructor
AbstractAnnotateController(java.lang.String id, java.lang.String name, java.lang.String caty) constructor

Method Summary

Modifier and Type	Method and Description
boolean	eulerStep(boolean step1, double dt, Machine mach) solve diff eqn.
abstract AnController	getAnController()
ICMLControlBlock	getControlBlockField(java.lang.String fieldName) Retrieve controller control block field by fieldName
AbstractChildAnnotateController	getControllerField(java.lang.String fieldName) Retrieve child controller field
double	getDoubleField(java.lang.String fieldName) Retrieve controller field parameter by fieldName
java.lang.Object	getEditPanel() Get the editor panel for controller data editing
abstract java.lang.reflect.Field	getField(java.lang.String fieldName)
abstract java.lang.Object	getFieldObject(java.lang.reflect.Field field)
double	getFieldVaule(java.lang.String fieldName) Get controller field value (u, y or state).
java.util.List<BaseFieldAnWrapper<? extends ICMLBlock>>	getFieldWrapperList() controller field list
ICMLFunctionExpression	getFunctionExpressionField(java.lang.String fieldName) Retrieve controller function expression field by fieldName
ICMLFunction	getFunctionField(java.lang.String fieldName) Retrieve controller function field by fieldName
int	getIntField(java.lang.String fieldName) Retrieve controller field parameter by fieldName
ICMLLookupTableFunction	getLookupTableFunctionField(java.lang.String fieldName) Retrieve controller lookup table function field by fieldName
double	getOutput()
double	getOutput(Machine mach)
double	getRefPoint() get controller reference point value
java.util.Hashtable<java.lang.String,java.lang.Object>	getStates(Machine mach, java.lang.Object ref)
java.util.Hashtable<java.lang.String,java.lang.Object>	getStates(java.lang.Object ref)
ICMLStaticBlock	getStaticBlockField(java.lang.String fieldName) Retrieve controller static block field by fieldName
boolean	initStates(BaseDStabBus<?,?> abus)
boolean	initStates(BaseDStabBus<?,?> abus, Machine mach) Init the controller states
boolean	nextStep(double dt, DynamicSimuMethod method)
boolean	nextStep(double dt, DynamicSimuMethod method, Machine mach) Perform one step diff eqn calculation
void	setRefPoint(double x)
java.lang.String	toString()

Methods inherited from class com.interpss.dstab.mach.impl.MachineControllerImpl

basicSetMachine, eBasicRemoveFromContainerFeature, eGet, eInverseAdd, eInverseRemove, eIsSet, eSet, eUnset, getCategory, getDataClass, getDStabBus, getMachine, getOutput, getType, initStates, initStates, readData, setCategory, setMachine, setType, writeData

Methods inherited from class com.interpss.dstab.device.impl.DynamicDeviceImpl

getOutputList, getOutputObject, getScripts, nextStepElectrical, nextStepMechanical, setScripts, updateAttributes

Methods inherited from class com.interpss.core.net.impl.NameTagImpl

checkData, checkData, copy, copyRef, getDesc, getId, getName, getNumber, isActive, isStatus, setDesc, setId, setName, setNumber, setStatus

Methods inherited from class org.eclipse.emf.ecore.impl.EObjectImpl

eAdapters, eClass, eContainerFeatureID, eDeliver, eInternalContainer, eInvoke, eIsProxy, eSetClass, eSetDeliver, eSetProxyURI

Methods inherited from class org.eclipse.emf.ecore.impl.BasicEObjectImpl

eAllContents, eBaseStructuralFeatureID, eBasicRemoveFromContainer, eBasicSetContainer, eContainer, eContainingFeature, eContainmentFeature, eContains, eContents, eCrossReferences, eDerivedOperationID, eDerivedOperationID, eDerivedStructuralFeatureID, eDerivedStructuralFeatureID, eDirectResource, eDynamicBasicRemoveFromContainer, eDynamicGet, eDynamicGet, eDynamicInverseAdd, eDynamicInverseRemove, eDynamicInvoke, eDynamicIsSet, eDynamicIsSet, eDynamicSet, eDynamicSet, eDynamicUnset, eDynamicUnset, eGet, eGet, eGet, eInternalResource, eInverseAdd, eInverseRemove, eInvoke, eIsSet, eObjectForURIFragmentSegment, eOpenGet, eOpenIsSet, eOpenSet, eOpenUnset, eProxyURI, eResolveProxy, eResource, eSet, eSetResource, eSetStore, eSetting, eStore, eUnset, eURIFragmentSegment, eVirtualGet, eVirtualGet, eVirtualIsSet, eVirtualSet, eVirtualUnset

Methods inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl

eNotificationRequired, eNotify

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.interpss.dstab.device.DynamicDevice

getScripts, setScripts

Methods inherited from interface com.interpss.core.net.NameTag

checkData, checkData, copy, copyRef, getDesc, getId, getName, getNumber, isActive, isStatus, setDesc, setId, setName, setNumber, setStatus

Methods inherited from interface com.interpss.dstab.algo.IDynamicSimulation

getOutputList, getOutputObject, nextStepElectrical, nextStepMechanical, updateAttributes

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.emf.ecore.InternalEObject

eNotificationRequired

Constructor Detail

AbstractAnnotateController

public AbstractAnnotateController()

constructor

AbstractAnnotateController

public AbstractAnnotateController(java.lang.String id,
                                  java.lang.String name,
                                  java.lang.String caty)

constructor

Parameters:

id - controller id

name - controller name

caty - controller category, for display info only

Method Detail

getAnController

public abstract AnController getAnController()

getFieldObject

public abstract java.lang.Object getFieldObject(java.lang.reflect.Field field)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getField

public abstract java.lang.reflect.Field getField(java.lang.String fieldName)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getDoubleField

public double getDoubleField(java.lang.String fieldName)
                      throws InterpssException

Retrieve controller field parameter by fieldName

Parameters:

fieldName - parameter name, for example, "this.ka"

Returns:

the parameter

Throws:

java.lang.Exception

InterpssException

getIntField

public int getIntField(java.lang.String fieldName)
                throws InterpssException

Retrieve controller field parameter by fieldName

Parameters:

fieldName - parameter name "this.ka"

Returns:

the parameter

Throws:

java.lang.Exception

InterpssException

getFunctionField

public ICMLFunction getFunctionField(java.lang.String fieldName)
                              throws InterpssException

Retrieve controller function field by fieldName

Parameters:

fieldName - field name "seFunc"

Returns:

the field object

Throws:

java.lang.Exception

InterpssException

getLookupTableFunctionField

public ICMLLookupTableFunction getLookupTableFunctionField(java.lang.String fieldName)
                                                    throws InterpssException

Retrieve controller lookup table function field by fieldName

Parameters:

fieldName - field name

Returns:

the field object

Throws:

java.lang.Exception

InterpssException

getFunctionExpressionField

public ICMLFunctionExpression getFunctionExpressionField(java.lang.String fieldName)
                                                  throws InterpssException

Retrieve controller function expression field by fieldName

Parameters:

fieldName - field name

Returns:

the field object

Throws:

java.lang.Exception

InterpssException

getStaticBlockField

public ICMLStaticBlock getStaticBlockField(java.lang.String fieldName)
                                    throws InterpssException

Retrieve controller static block field by fieldName

Parameters:

fieldName - field name "gainBlock"

Returns:

the field object

Throws:

java.lang.Exception

InterpssException

getControlBlockField

public ICMLControlBlock getControlBlockField(java.lang.String fieldName)
                                      throws InterpssException

Retrieve controller control block field by fieldName

Parameters:

fieldName - field name "delayBlock"

Returns:

the field object

Throws:

java.lang.Exception

InterpssException

getControllerField

public AbstractChildAnnotateController getControllerField(java.lang.String fieldName)
                                                   throws InterpssException

Retrieve child controller field

Parameters:

fieldName -

Returns:

Throws:

java.lang.Exception

InterpssException

getFieldVaule

public double getFieldVaule(java.lang.String fieldName)
                     throws InterpssException

Get controller field value (u, y or state). It is used to access child controller field value

Parameters:

fieldName, - fieldName format : .y, u or state

Returns:

field value

Throws:

InterpssException

getFieldWrapperList

public java.util.List<BaseFieldAnWrapper<? extends ICMLBlock>> getFieldWrapperList()

controller field list

Returns:

initStates

public boolean initStates(BaseDStabBus<?,?> abus,
                          Machine mach)

Init the controller states

Specified by:

initStates in interface IDynamicSimulation

Overrides:

initStates in class DynamicDeviceImpl

Parameters:

msg - the SessionMsg object

initStates

public boolean initStates(BaseDStabBus<?,?> abus)

Description copied from class: DynamicDeviceImpl

Specified by:

initStates in interface IDynamicSimulation

Overrides:

initStates in class DynamicDeviceImpl

nextStep

public boolean nextStep(double dt,
                        DynamicSimuMethod method,
                        Machine mach)

Perform one step diff eqn calculation

Specified by:

nextStep in interface IDynamicSimulation

Overrides:

nextStep in class DynamicDeviceImpl

Parameters:

dt - simulation time interval

method - d-eqn solution method

msg - the IPSSMsgHub object, for communication with the outside world

nextStep

public boolean nextStep(double dt,
                        DynamicSimuMethod method)

Description copied from class: DynamicDeviceImpl

Specified by:

nextStep in interface IDynamicSimulation

Overrides:

nextStep in class DynamicDeviceImpl

Parameters:

dt - the time step for solving the differential eqn.

getOutput

public double getOutput(Machine mach)

Description copied from class: DynamicDeviceImpl

Specified by:

getOutput in interface IDynamicSimulation

Overrides:

getOutput in class DynamicDeviceImpl

getOutput

public double getOutput()

Description copied from class: DynamicDeviceImpl

Specified by:

getOutput in interface IDynamicSimulation

Overrides:

getOutput in class DynamicDeviceImpl

getStates

public java.util.Hashtable<java.lang.String,java.lang.Object> getStates(Machine mach,
                                                                        java.lang.Object ref)

Description copied from class: MachineControllerImpl

Specified by:

getStates in interface IDynamicSimulation

Overrides:

getStates in class MachineControllerImpl

getStates

public java.util.Hashtable<java.lang.String,java.lang.Object> getStates(java.lang.Object ref)

Description copied from class: MachineControllerImpl

Specified by:

getStates in interface IDynamicSimulation

Overrides:

getStates in class MachineControllerImpl

getEditPanel

public java.lang.Object getEditPanel()

Get the editor panel for controller data editing

Specified by:

getEditPanel in interface MachineController

Overrides:

getEditPanel in class MachineControllerImpl

Returns:

the editor panel object

setRefPoint

public void setRefPoint(double x)

Description copied from class: MachineControllerImpl

Specified by:

setRefPoint in interface MachineController

Overrides:

setRefPoint in class MachineControllerImpl

getRefPoint

public double getRefPoint()

get controller reference point value

Returns:

eulerStep

public boolean eulerStep(boolean step1,
                         double dt,
                         Machine mach)

solve diff eqn. calculation order needs from the largest initOrder number to the lowest initOrder number

Parameters:

step1 -

dt -

mach -

Returns:

toString

public java.lang.String toString()

Description copied from class: MachineControllerImpl

Overrides:

toString in class MachineControllerImpl