public abstract class TransSecsGEMController extends TransSecsVoyeur
Modifier and Type | Class and Description |
---|---|
class |
TransSecsGEMController.ConnectionEventListener
The SecsEvent Listener.
|
static class |
TransSecsGEMController.ConnectionStates
Possible connection states
|
TransSecsController.ResponseWrapper
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALID_STR
The string used to describe all the ALIDs.
|
static java.lang.String |
CEID_STR
The string used to describe all the CEIDs.
|
static int |
debugLevel
Set this to enable debugging.
|
static Logger |
LOG |
static java.lang.String |
VID_STR
The string used to describe all the value IDs (VID, ECID, SVID, DVNAME).
|
activeDefaultMessageHandler, beanDebugLevel
ACTIVE_PORT, allInstances, connectionConfig, csvFolder, DEFAULT_TRANSSECS_APPLICATION, defaultMessageHandler, DEVICES_CLIENT_TRANSSECS_APPLICATION, FILE_RECIPE_MANAGER, invertHostOrEquipmentConnection, lastProcessed, PASSIVE_PORT, passThroughGlobal, recipeBaseDir, recipeFileExtension, recipeManager, recipeManagerType, testPanel, transSecsApplicationType
Constructor and Description |
---|
TransSecsGEMController()
Create the controller.
|
Modifier and Type | Method and Description |
---|---|
void |
addAlarmListener(AlarmListener alarmListener)
Add a alarm listener.
|
void |
addConnectionStatusListener(ConnectionStatusListener connectionStatusListener)
Add a connection status listener.
|
void |
addEventListener(long ceid,
EventListener eventListener)
Add a event listener.
|
void |
addGemModelChangedListener(GemModelChangedListener listener)
Add a GEM model changed listener.
|
void |
addReportListener(long rptid,
ReportListener reportListener)
Add a report listener.
|
void |
addTraceListener(long trid,
TraceListener traceListener)
Add a alarm listener.
|
void |
addVidListener(long vid,
VidListener vidListener)
Add a Vid listener.
|
java.lang.String |
characterize()
Populate the GemHostModel by characterization.
|
void |
configure()
Configure the GEM system.
|
void |
connect()
Connect to the tool.
|
void |
destroy()
Remove this class as a simulation listener and perform any other cleanup.
|
int |
getAlidSecsFormat() |
int |
getCeidSecsFormat() |
int |
getDataIdSecsFormat() |
GemHostModel |
getGemHostModel()
Return the model.
|
java.lang.String |
getGemHostModelJSON()
Returns the GEM Host model as a JSON String.
|
EventListener |
getGlobalEventListener()
Returns the global event listen.
|
HostIDBean |
getHostIDBean()
The bean that contains the host variables.
|
java.util.List<java.util.List<ConnectorTransientRepresentation>> |
getHostIdBeanConnectors()
Store all the connectors that are associated with the HostId bean so that they can be restored if the bean
is recreated.
|
java.lang.String |
getMDLN()
Returns the MDLN.
|
<T extends VIBMessageBean> |
getMessageBean(java.lang.String name,
java.lang.Class<? extends VIBMessageBean> clazz)
Find a message bean that is a particualar class.
|
int |
getRptidSecsFormat() |
SimulationListener |
getSimulationListener()
Return the simulation listener, creating if necessary.
|
java.lang.String |
getSoftRev()
Returns the SoftRev.
|
int |
getTotsmpSecsFormat() |
int |
getTridSecsFormat() |
int |
getVidSecsFormat() |
void |
init()
Subclasses will fill in the data needed to make a connection.
|
void |
initHostIDBean()
Initialize the Host ID Bean with the values from the model.
|
boolean |
isCharacterizationInProgress() |
boolean |
isEnableAllAlarms() |
boolean |
isEnableAllEvents() |
boolean |
isInitializationFlag() |
static int |
parseFormatString(java.lang.String formatString)
Parse the string and ensure that it is a valid type.
|
boolean |
processMessage(SecsTrigger msg)
Calls the super-classes processMessage and returns true.
|
GemHostModel |
readGemHostModel(java.lang.String filename)
Read the GEMHost model from a file.
|
java.lang.String |
readJSONFromFile(java.lang.String filename)
Read the json model from a file.
|
void |
removeAlarmListener(AlarmListener alarmListener)
Remove a alarm listener.
|
void |
removeConnectionStatusListener(ConnectionStatusListener connectionStatusListener)
Remove a connection status listener.
|
void |
removeEventListener(long ceid,
EventListener eventListener)
Remove a event listener.
|
void |
removeGemModelChangedListener(GemModelChangedListener listener)
Remove a GEM model changed listener.
|
void |
removeReportListener(long rptid,
ReportListener reportListener)
Remove a report listener.
|
void |
removeTraceListener(long trid,
TraceListener traceListener)
Remove a alarm listener.
|
void |
removeVidListener(long vid,
VidListener vidListener)
Remove a Vid listener.
|
void |
saveGemHostModel(java.lang.String modelFileName)
Save the GEM Host Model to JSON
|
void |
setAlidSecsFormat(int alidSecsFormat) |
void |
setCeidSecsFormat(int ceidSecsFormat) |
void |
setCharacterizationInProgress(boolean characterizationInProgress) |
void |
setControllerName(java.lang.String controllerName)
Register data source for all the elements of the host model.
|
void |
setDataIdSecsFormat(int dataIdSecsFormat) |
void |
setEnableAllAlarms(boolean enableAllAlarms) |
void |
setEnableAllEvents(boolean enableAllEvents) |
void |
setGemHostModel(GemHostModel gemHostModel)
Replace the gemHostModel.
|
void |
setGemHostModelJSON(java.lang.String json)
Set the GEM Host Model as a JSON String.
|
void |
setGlobalEventListener(EventListener globalEventListener)
Sets the global event listener.
|
void |
setHostIdBeanConnectors(java.util.List<java.util.List<ConnectorTransientRepresentation>> connectors)
Restores the collection of connectors to the new HostID bean.
|
void |
setInitializationFlag(boolean initializationFlag) |
void |
setJOptionPane(javax.swing.JOptionPane jOptionPane) |
void |
setMDLN(java.lang.String mdln)
Set the MDLN.
|
void |
setPassThrough(boolean passThrough) |
void |
setPort(int port)
Setting this to a value >= 0 will change this to a passthrough application.
|
void |
setRptidSecsFormat(int rptidSecsFormat) |
void |
setSoftRev(java.lang.String softRev)
Set the softrev.
|
void |
setTotsmpSecsFormat(int totsmpSecsFormat) |
void |
setTridSecsFormat(int tridSecsFormat) |
void |
setVidSecsFormat(int vidSecsFormat) |
void |
start()
Connect on Start.
|
void |
startPoll(GemHostModel.GemTraceVariable traceVariable)
Start polling a trace variable for a specific number of samples
|
void |
stop()
Stop the component.
|
void |
stopHostIDBean(GemHostModel oldGemHostModel)
Remove all the connections from the Host ID Bean with the values from the model.
|
void |
stopPoll(GemHostModel.GemTraceVariable traceVariable)
Stop polling a trace variable manually
|
void |
updateAlarmListeners(AlarmValues alarmValues)
Update all alarm listeners.
|
void |
updateConnectionStatusListeners(TransSecsGEMController.ConnectionStates connectionStatus,
java.lang.String comment)
Update all connection status listeners.
|
void |
updateEventListeners(GemToolModelSnapshot.GemReportVariable ceid,
java.util.List<ReportValues> eventValues)
Update all event listeners.
|
void |
updateGemModelChangedListeners()
Update all GEM model changed listeners.
|
void |
updateReportListeners(ReportValues report)
Update all report listeners.
|
void |
updateTraceListeners(GemHostModel.GemTraceVariable trid,
java.util.List<GemHostModel.GemValueVariable> values)
Update all trace listeners.
|
void |
updateVidListeners(GemHostModel.GemValueVariable vidValue)
Update all Vid listeners.
|
connect, disconnect, disconnectActive, getActivePort, getActiveT1, getActiveT2, getActiveT3, getActiveT4, getActiveT5, getActiveT6, getActiveT7, getActiveT8, getActiveToolTarget, getBeanDebugLevel, getEquipmentHostName, getWrapper, setActivePort, setActiveT1, setActiveT2, setActiveT3, setActiveT4, setActiveT5, setActiveT6, setActiveT7, setActiveT8, setActiveToolTarget, setActiveWrapperClassName, setDebugLevel, setEquipmentHostName, setLogger, setT1, setT2, setT3, setT4, setT5, setT6, setT7, setT8, toString
addALID, addALID, addALIDsFromCSV, addCEID, addCEID, addCEIDsFromCSV, addDependentEInterface, addDVID, addECID, addSVID, addVID, addVIDsFromCSV, createDataId, createDevices, createSecsFormat3x5x, disconnectPassive, findController, getActiveConnectionRetryInterval, getAlids, getAllMessages, getAutoResponseMessages, getBaudRate, getCeids, getClassPackage, getConnectionConfig, getControllerName, getDeviceId, getEquipmentWrapper, getGemCompliant, getGemHandler, getLinkTestInterval, getLocalDebug, getLogger, getMatchingPrimary, getMatchingResponse, getMessageBean, getPassiveT1, getPassiveT2, getPassiveT3, getPassiveT4, getPassiveT5, getPassiveT6, getPassiveT7, getPassiveT8, getPassiveToolTarget, getPersistenceFileName, getPort, getSingleController, getUnhandledPrimaries, getVids, getWrapperDescription, handleHandCraftedMessage, isAllowDuplicateSECSIMessages, isDigitalTwin, isPassThrough, isS1F3ReturnsValues, logInfo, newInstance, println, processMessage, processMessage, publish, publish, publishReport, register, registerEventComponents, registerForReceiveNotification, registerInstance, removeDependentEInterface, sendResponse, setActiveConnectionRetryInterval, setAllowDuplicateSECSIMessages, setBaudRate, setClassPackage, setConnectionConfig, setDeviceId, setDigitalTwin, setFileRecipeManagerExtension, setFileRecipeManagerPath, setGemCompliant, setLinkTestInterval, setLocalDebug, setPassiveT1, setPassiveT2, setPassiveT3, setPassiveT4, setPassiveT5, setPassiveT6, setPassiveT7, setPassiveT8, setPassiveToolTarget, setPassiveWrapperClassName, setPersistenceFileName, setS1F3ReturnsValues, setSoftRevAndMDLN, setupFileRecipeManager, unregisterInstance, valueInput
public static final java.lang.String ALID_STR
public static final java.lang.String CEID_STR
public static int debugLevel
public static final Logger LOG
public static final java.lang.String VID_STR
public void addAlarmListener(AlarmListener alarmListener)
alarmListener
- the alarm listenerpublic void addConnectionStatusListener(ConnectionStatusListener connectionStatusListener)
connectionStatusListener
- the connection status listenerpublic void addEventListener(long ceid, EventListener eventListener)
eventListener
- the event listenerpublic void addGemModelChangedListener(GemModelChangedListener listener)
gemModelChangedListener
- the GEM model changed listenerpublic void addReportListener(long rptid, ReportListener reportListener)
reportListener
- the report listenerpublic void addTraceListener(long trid, TraceListener traceListener)
alarmListener
- the alarm listenerpublic void addVidListener(long vid, VidListener vidListener)
vidListener
- the Vid listenerpublic java.lang.String characterize()
public void configure()
public void connect()
public void destroy() throws BadParameterException
destroy
in class TransSecsVoyeur
BadParameterException
public int getAlidSecsFormat()
GemHostModel.getAlidSecsFormat()
public int getCeidSecsFormat()
GemHostModel.getCeidSecsFormat()
public int getDataIdSecsFormat()
GemHostModel.getDataIdSecsFormat()
public GemHostModel getGemHostModel()
public java.lang.String getGemHostModelJSON()
public EventListener getGlobalEventListener()
public HostIDBean getHostIDBean()
public java.util.List<java.util.List<ConnectorTransientRepresentation>> getHostIdBeanConnectors()
public java.lang.String getMDLN()
public <T extends VIBMessageBean> T getMessageBean(java.lang.String name, java.lang.Class<? extends VIBMessageBean> clazz) throws BadParameterException
name
- the name of the requested messageclazz
- the class of the message.BadParameterException
public int getRptidSecsFormat()
GemHostModel.getRptidSecsFormat()
public SimulationListener getSimulationListener()
getSimulationListener
in class TransSecsController
public java.lang.String getSoftRev()
public int getTotsmpSecsFormat()
GemHostModel.getTotsmpSecsFormat()
public int getTridSecsFormat()
GemHostModel.getTridSecsFormat()
public int getVidSecsFormat()
GemHostModel.getVidSecsFormat()
public void init() throws BadParameterException
TransSecsController
init
in class TransSecsController
BadParameterException
public void initHostIDBean()
public boolean isCharacterizationInProgress()
public boolean isEnableAllAlarms()
GemHostModel.isEnableAllAlarms()
public boolean isEnableAllEvents()
GemHostModel.isEnableAllEvents()
public boolean isInitializationFlag()
public static int parseFormatString(java.lang.String formatString) throws java.lang.NumberFormatException
java.lang.NumberFormatException
public boolean processMessage(SecsTrigger msg)
processMessage
in class TransSecsVoyeur
public GemHostModel readGemHostModel(java.lang.String filename)
public java.lang.String readJSONFromFile(java.lang.String filename)
public void removeAlarmListener(AlarmListener alarmListener)
alarmListener
- the alarm listenerpublic void removeConnectionStatusListener(ConnectionStatusListener connectionStatusListener)
connectionStatusListener
- the connection status listenerpublic void removeEventListener(long ceid, EventListener eventListener)
eventListener
- the event listenerpublic void removeGemModelChangedListener(GemModelChangedListener listener)
gemModelChangedListener
- the GEM model changed listenerpublic void removeReportListener(long rptid, ReportListener reportListener)
reportListener
- the report listenerpublic void removeTraceListener(long trid, TraceListener traceListener)
alarmListener
- the alarm listenerpublic void removeVidListener(long vid, VidListener vidListener)
vidListener
- the Vid listenerpublic void saveGemHostModel(java.lang.String modelFileName)
modelFile
- the file to which to save.public void setAlidSecsFormat(int alidSecsFormat)
alidSecsFormat
- GemHostModel.setAlidSecsFormat(int)
public void setCeidSecsFormat(int ceidSecsFormat)
ceidSecsFormat
- GemHostModel.setCeidSecsFormat(int)
public void setCharacterizationInProgress(boolean characterizationInProgress)
characterizationInProgress
- the characterizationInProgress to setpublic void setControllerName(java.lang.String controllerName)
setControllerName
in class TransSecsController
public void setDataIdSecsFormat(int dataIdSecsFormat)
dataIdSecsFormat
- GemHostModel.setDataIdSecsFormat(int)
public void setEnableAllAlarms(boolean enableAllAlarms)
enableAllEvents
- GemHostModel.setEnableAllAlarms(boolean)
public void setEnableAllEvents(boolean enableAllEvents)
enableAllEvents
- GemHostModel.setEnableAllEvents(boolean)
public void setGemHostModel(GemHostModel gemHostModel)
gemHostModel
- public void setGemHostModelJSON(java.lang.String json)
public void setGlobalEventListener(EventListener globalEventListener)
globalEventListener
- the globalEventListener to setpublic void setHostIdBeanConnectors(java.util.List<java.util.List<ConnectorTransientRepresentation>> connectors)
connectors
- public void setInitializationFlag(boolean initializationFlag)
initializationFlag
- true if the connection is initialized, otherwise false.public void setJOptionPane(javax.swing.JOptionPane jOptionPane)
jOptionPane
- the jOptionPane to setpublic void setMDLN(java.lang.String mdln)
mdln
- public void setPassThrough(boolean passThrough)
setPassThrough
in class TransSecsController
passThrough
- public void setPort(int port)
setPort
in class TransSecsVoyeur
port
- the port on which to listen for a host connection. All messages received on this port will be sent to the tool and vice versa.public void setRptidSecsFormat(int rptidSecsFormat)
rptidSecsFormat
- GemHostModel.setRptidSecsFormat(int)
public void setSoftRev(java.lang.String softRev)
softRev
- public void setTotsmpSecsFormat(int totsmpSecsFormat)
totsmpSecsFormat
- GemHostModel.setTotsmpSecsFormat(int)
public void setTridSecsFormat(int tridSecsFormat)
tridSecsFormat
- GemHostModel.setTridSecsFormat(int)
public void setVidSecsFormat(int vidSecsFormat)
vidSecsFormat
- GemHostModel.setVidSecsFormat(int)
public void start() throws BadParameterException, VIBUpdateFailedException
start
in class TransSecsVoyeur
BadParameterException
VIBUpdateFailedException
TransSecsController.start()
public void startPoll(GemHostModel.GemTraceVariable traceVariable)
public void stop() throws BadParameterException
TransSecsController
stop
in class TransSecsVoyeur
BadParameterException
public void stopHostIDBean(GemHostModel oldGemHostModel)
oldGemHostModel
- the host model that is being retired/replaced.public void stopPoll(GemHostModel.GemTraceVariable traceVariable)
public void updateAlarmListeners(AlarmValues alarmValues)
alarmValues
- the alarm valuespublic void updateConnectionStatusListeners(TransSecsGEMController.ConnectionStates connectionStatus, java.lang.String comment)
connectionStatus
- the current connection statuscomment
- a, possibly blank, comment that may provide some insight into the connection.public void updateEventListeners(GemToolModelSnapshot.GemReportVariable ceid, java.util.List<ReportValues> eventValues)
vidValues
- the values of the VIDs in the event as received from the tool.public void updateGemModelChangedListeners() throws VIBUpdateFailedException, BadParameterException
public void updateReportListeners(ReportValues report)
reportValues
- the values of the reports in the report as received from the tool.public void updateTraceListeners(GemHostModel.GemTraceVariable trid, java.util.List<GemHostModel.GemValueVariable> values)
values
- the values of the VIDs in the trace as received from the tool.trid
- the trace idpublic void updateVidListeners(GemHostModel.GemValueVariable vidValue)
vidValues
- the values of the VIDs in the Vid as received from the tool.Copyright © 1999-2025 ErgoTech Systems, Inc. All Rights Reserved.