com.ergotech.transsecs.secs

Class VIBOutMessageBean

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.transsecs.secs.PublishBean

com.ergotech.transsecs.secs.VIBMessageBean

com.ergotech.transsecs.secs.VIBOutMessageBean

All Implemented Interfaces:

MessageResponseInterface, SecsDefinedMessage, java.lang.Cloneable

Direct Known Subclasses:

AlarmAck, ALIDListRequest, AreYouThereFromHost, AreYouThereResponseFromHost, CEIDListRequest, CEIDReportsRequest, CreateReports, DeleteReport, DeleteReports, DisableEvents, DisableSpooling, ECIDListRequest, ECIDValueRequest, EnableAlarm, EnableAllAlarms, EnableAllEvents, EnabledAlarmsListRequest, EnableDisableEvents, EnableEvents, EstablishCommunications, EstablishCommunicationsResponseToTool, EventMessageACK, EventReportRequest, LinkReports, MultiblockGrant, RequestOnline, SendS1F3Poll, SpoolDataRequest, SVIDListRequest, SVIDValueRequest, TraceDataACK, TraceInitializationSend, UnlinkReports

public abstract class VIBOutMessageBean
extends VIBMessageBean

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.transsecs.secs.VIBMessageBean

VIBMessageBean.WaitForResponse

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields inherited from class com.ergotech.transsecs.secs.VIBMessageBean

ANY_CHANGE, ERROR_STATUS_NAME, FALLING_EDGE, firstPublish, gemCompliant, GOOD_STATUS_NAME, RESPONSE_STATUS_NAME, RISING_EDGE, SEND_MESSAGE_NAME, showThinking, transSecsController

Fields inherited from class com.ergotech.vib.manipulators.SimpleManipulator

cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Fields inherited from interface com.ergotech.secs.MessageResponseInterface

cvsRev

Constructor Summary

Constructors

Constructor and Description
VIBOutMessageBean()

Method Summary

Modifier and Type	Method and Description
void	publish(java.lang.String tagName, ValueObjectInterface value) Publish should not be called on an out object.
boolean	publishData(SecsMsg msg) Publishs the data from unsolicted messages is they match an incoming message.
boolean	receiveMessage(SecsMsg msg, boolean doPublish, boolean logInfo) Process the incoming message.
void	register(java.lang.String inportName, java.lang.Object value) Register the data source name.
void	register(java.lang.String dataSourceName, java.lang.Object value, java.lang.String script, java.lang.String deviceName, java.lang.String tagName) Register the data source name.

Methods inherited from class com.ergotech.transsecs.secs.VIBMessageBean

addValueChangedListener, clearMessage, clone, createMessage, createMessage, createMessageForDigitalTwin, createMessageForDigitalTwin, equals, getConnectOnSend, getControllerName, getControllerPort, getFunction, getHcack, getHostMessageErrorLists, getName, getPeepOnly, getPublishedAccessorContainer, getResponse, getResponse, getResponseMessage, getResponseMessageName, getSecsMsg, getStream, getTriggerEdge, hashCode, hostMessageError, hostMessageParameterMatchError, init, isGemCompliant, isHandleAsHostMessage, isHandleHostMessageErrors, logInfo, notifyReceive, println, processMessage, receiveMessage, receiveMessage, receiveMessageForDigitalTwin, removeValueChangedListener, resetAutoResponseTable, responseReceived, sendErrorResponse, sendMessage, sendMessage, sendMessage, sendMessage, sendMessageAndWait, sendMessageAndWait, sendMessageFromOPC, setConnectOnSend, setControllerName, setControllerPort, setGemCompliant, setHandleAsHostMessage, setHandleHostMessageErrors, setHcack, setHostMessageErrorLists, setName, setPeepOnly, setResponse, setSecsMsg, setTriggerEdge, start, toJSONString, toString

Methods inherited from class com.ergotech.transsecs.secs.PublishBean

addConnectionToDataSource, addConnectionToDevice, convertByteArray, convertFromSecsFormat00, convertSecsFormat, displayTimedPopup, getCurrentQualitySetting, getPrivateField, idTypeFromFormat, publish, publish, publish, publish, publish, publish, publish, publish, publish, publish, publish, removeConnectionFromDevice, setCurrentQualitySetting

Methods inherited from class com.ergotech.vib.manipulators.SimpleManipulator

getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, valueChanged, valueInput

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, stop, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VIBOutMessageBean

public VIBOutMessageBean()

Method Detail

publish

public void publish(java.lang.String tagName,
                    ValueObjectInterface value)

Publish should not be called on an out object.

Overrides:

publish in class PublishBean

Parameters:

name - the assigned named of the value being published

value - the value being published

publishData

public boolean publishData(SecsMsg msg)

Publishs the data from unsolicted messages is they match an incoming message.

Specified by:

publishData in interface SecsDefinedMessage

Specified by:

publishData in class VIBMessageBean

receiveMessage

public boolean receiveMessage(SecsMsg msg,
                              boolean doPublish,
                              boolean logInfo)
                       throws SecsException

Process the incoming message. This should never be called on an out message and will always return false.

Specified by:

receiveMessage in class VIBMessageBean

Throws:

SecsException

register

public void register(java.lang.String inportName,
                     java.lang.Object value)
              throws BadParameterException

Register the data source name. This will create a datasource with the given name and add it to this object.

Parameters:

dataSourceName - the name of the datasource to create

value - ignored

Throws:

BadParameterException - never thrown

register

public void register(java.lang.String dataSourceName,
                     java.lang.Object value,
                     java.lang.String script,
                     java.lang.String deviceName,
                     java.lang.String tagName)
              throws BadParameterException

Register the data source name. This will create a datasource with the given name and add it to this object.

Parameters:

dataSourceName - the name of the datasource to create

value - the value to use to initialize the data source.

script - the script to execute after the value is set. If this is null or an empty string it is ignored.

deviceName - the name of the device from which the value should be taken before sending the message

tagName - the tagname from which the value should be taken before sending the message

Throws:

BadParameterException - thrown if addDataSource throws