com.interpss.dstab.mach

Interface MachineController

All Superinterfaces:

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

All Known Implementing Classes:

AbstractAnnotateController, AbstractChildAnnotateController, AbstractExciter, AbstractGovernor, AbstractStabilizer, AnnotateExciter, AnnotateGovernor, AnnotateStabilizer, MachineControllerImpl

public interface MachineController
extends DynamicDevice

A representation of the model object 'Controller'. Generic machine controller class. Actual excitor, governor or pss model implementation will inheriate this base class.

The following features are supported:

• Type
• Category
• Machine

See Also:

DstabMachPackage.getMachineController()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory() Returns the value of the 'Category' attribute.
java.lang.Class<?>	getDataClass() Get the controller data object class for persist/retrieve the data object.
BaseDStabBus<?,?>	getDStabBus() get the DStab bus object containing the paraent machine object
java.lang.Object	getEditPanel() Get the controller editor panel, by default, a JPanel object.
Machine	getMachine() Returns the value of the 'Machine' container reference.
MachineControllerType	getType() Returns the value of the 'Type' attribute.
void	setCategory(java.lang.String value) Sets the value of the 'Category' attribute.
void	setMachine(Machine value) Sets the value of the 'Machine' container reference.
void	setRefPoint(double x) Set ref point of the controller for testing purpose.
void	setType(MachineControllerType value) Sets the value of the 'Type' attribute.

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.hazelcast.nio.serialization.DataSerializable

readData, writeData

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

getOutput, getOutput, getOutputList, getOutputObject, getStates, getStates, initStates, initStates, initStates, nextStep, nextStep, 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

Method Detail

getType

MachineControllerType getType()

Returns the value of the 'Type' attribute. The literals are from the enumeration MachineControllerType.

If the meaning of the 'Type' attribute isn't clear, there really should be more of a description here...

Controller type

Returns:

the value of the 'Type' attribute.

See Also:

MachineControllerType, setType(MachineControllerType), DstabMachPackage.getMachineController_Type()

setType

void setType(MachineControllerType value)

Sets the value of the 'Type' attribute.

Parameters:

value - the new value of the 'Type' attribute.

See Also:

MachineControllerType, getType()

getDataClass

java.lang.Class<?> getDataClass()

Get the controller data object class for persist/retrieve the data object.

setRefPoint

void setRefPoint(double x)

Set ref point of the controller for testing purpose.

getDStabBus

BaseDStabBus<?,?> getDStabBus()

get the DStab bus object containing the paraent machine object

getCategory

java.lang.String getCategory()

Returns the value of the 'Category' attribute. The default value is "Default".

If the meaning of the 'Category' attribute isn't clear, there really should be more of a description here...

The controller category info for grouping controller. Not used in the simulation.

Returns:

the value of the 'Category' attribute.

See Also:

setCategory(String), DstabMachPackage.getMachineController_Category()

setCategory

void setCategory(java.lang.String value)

Sets the value of the 'Category' attribute.

Parameters:

value - the new value of the 'Category' attribute.

See Also:

getCategory()

getMachine

Machine getMachine()

Returns the value of the 'Machine' container reference. It is bidirectional and its opposite is 'Controller List'.

If the meaning of the 'Machine' container reference isn't clear, there really should be more of a description here...

The controller parent machine object

Returns:

the value of the 'Machine' container reference.

See Also:

setMachine(Machine), DstabMachPackage.getMachineController_Machine(), Machine.getControllerList()

setMachine

void setMachine(Machine value)

Sets the value of the 'Machine' container reference.

Parameters:

value - the new value of the 'Machine' container reference.

See Also:

getMachine()

getEditPanel

java.lang.Object getEditPanel()

Get the controller editor panel, by default, a JPanel object.