com.ergotech.transsecs.secs

Class VIBMessageBean

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

All Implemented Interfaces:

MessageResponseInterface, SecsDefinedMessage, java.lang.Cloneable

Direct Known Subclasses:

VIBInMessageBean, VIBInOutMessageBean, VIBOutMessageBean

public abstract class VIBMessageBean
extends PublishBean
implements SecsDefinedMessage, MessageResponseInterface, java.lang.Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	VIBMessageBean.WaitForResponse Called when the CreateReportsResponse message is received.

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

Modifier and Type	Field and Description
static int	ANY_CHANGE Send the message on the whenever the value changes outside of the deadband.
static java.lang.String	ERROR_STATUS_NAME This datasource will be triggered if an error response is recieved to a message.
static int	FALLING_EDGE Only send the message on the FALLING edge.
boolean	firstPublish This is set for the first publish for each published item.
static boolean	gemCompliant Whether we are running with GEM compliance.
static java.lang.String	GOOD_STATUS_NAME This datasource will be triggered if a good response is recieved to a message.
static java.lang.String	RESPONSE_STATUS_NAME This is the name that we publish use to publish the received response.
static int	RISING_EDGE Only send the message on the RISING edge.
static java.lang.String	SEND_MESSAGE_NAME This is the name that we publish use to send the.
static boolean	showThinking Whether to show the logic of matching messages.
TransSecsController	transSecsController This is the transSecsController for this message bean.

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
VIBMessageBean() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addValueChangedListener(java.lang.Object listener) Creates a connector from the default outport of this server to the method called "valueInput" of the provided object.
SecsFormat00	clearMessage(SecsFormat00 mainList) If the message is bi-directional, receiving the message will populate all the lists in the message with data.
java.lang.Object	clone() Permit cloning of this instance so that we can test receiving without impacting the instance that is held by the controller.
abstract SecsMsg	createMessage() Create the secs message.
SecsMsg	createMessage(boolean detailedLogging) Available to be overridden by subclasses to create a detailed SML string for logging.
SecsMsg	createMessageForDigitalTwin() Create the secs message.
SecsMsg	createMessageForDigitalTwin(boolean detailedLogging) Create the secs message.
boolean	equals(java.lang.Object obj) Equals includes the name of the bean and the name of the controller.
boolean	getConnectOnSend() Returns connect on send.
java.lang.String	getControllerName() Returns the message port name.
int	getControllerPort() Returns the controller port.
abstract int	getFunction() Returns the function of this message.
int	getHcack() Used to determine if an autoresponse needs to be sent.
java.util.List<SecsFormat>	getHostMessageErrorLists()
java.lang.String	getName() This will return the name.
boolean	getPeepOnly() To take a look at the data in a message and then pass it on to the host without handling it set snoop only.
DataSourceContainer	getPublishedAccessorContainer() Returns the container with the name of our controller.
SecsDefinedMessage	getResponse() Sets the response message by string
static VIBMessageBean	getResponse(java.lang.String messageName) Returns the response message by string
VIBMessageBean	getResponseMessage() Sets the response message by string.
java.lang.String	getResponseMessageName() Sets the response message by string.
SecsMsg	getSecsMsg() returns the raw secs message associated with this object.
abstract int	getStream() Returns the stream of this message.
int	getTriggerEdge() The edge that will trigger the message to be sent.
int	hashCode() The hashcode uses the name of the controller and the name of the bean.
void	hostMessageError(java.lang.String cpname, int cpack, int hcack, java.lang.String errorDescription) Indicate that an error has occured in processing a host message and create the error list if appropriate.
boolean	hostMessageParameterMatchError(SecsMsg hostMessage, java.util.Set<java.lang.String> matched, SecsFormat00 paramList, java.util.List<java.lang.String> expected) Indicate that an error has occured in processing a host message and create the error list if appropriate.
void	init() Add the event messages as CEIDs.
static boolean	isGemCompliant()
boolean	isHandleAsHostMessage()
boolean	isHandleHostMessageErrors()
static void	logInfo(java.lang.String message) Log information about the reception of messages.
void	notifyReceive() Update all listeners to indicate that the message has been received.
void	println(java.lang.String s) Prints out the provided string.
boolean	processMessage(SecsMsg msg) Process the response to the sent message - if any.
abstract boolean	publishData(SecsMsg msg) Publishs the data from unsolicted messages is they match an incoming message.
boolean	receiveMessage(SecsMsg msg, boolean doPublish) Process the response to the sent message.
abstract boolean	receiveMessage(SecsMsg msg, boolean doPublish, boolean logInfo) Process the response to the sent message.
boolean	receiveMessage(SecsMsg sm, boolean doPublish, boolean logInfo, java.lang.StringBuilder sml) Process the response to the sent message.
boolean	receiveMessageForDigitalTwin(SecsMsg msg, boolean doPublish, boolean logInfo) Process the response to the sent message.
void	removeValueChangedListener(java.lang.Object listener) Creates a connector from the default outport of this server to the method called "valueInput" of the provided object.
static void	resetAutoResponseTable()
boolean	responseReceived(int status, SecsMsg primary, SecsMsg response) The MsgResponseInterface.
boolean	sendErrorResponse(SecsMsg hostMessage, boolean defaultReturn) Send the S2F42 if appropriate.
SecsMsg	sendMessage() Send the message.
SecsMsg	sendMessage(int deviceId) Send the message.
void	sendMessage(java.lang.Object delegate) Sends the message and notify the delegate when the response is recevied.
void	sendMessage(ValueChangedEvent newEvent) This method will send the message.
<T extends VIBMessageBean> T	sendMessageAndWait() Sends the message and waits for the response.
<T extends VIBMessageBean> T	sendMessageAndWait(int deviceId) Sends the message and waits for the response.
void	sendMessageFromOPC() Send a message from an OPC server.
void	setConnectOnSend(boolean connectOnSend) Sets connect on send.
void	setControllerName(java.lang.String controllerName) Sets the controller name.
void	setControllerPort(int controllerPort) Sets the controller port.
static void	setGemCompliant(boolean gemCompliant)
void	setHandleAsHostMessage(boolean handleAsHostMessage)
void	setHandleHostMessageErrors(boolean handleHostMessageErrors)
void	setHcack(int hcack) Used in the generated code to set the variable.
void	setHostMessageErrorLists(java.util.List<SecsFormat> hostMessageErrorLists)
void	setName(java.lang.String newName) Set the name of this component.
void	setPeepOnly(boolean peepOnly) To take a look at the data in a message and then pass it on to the host without handling it set snoop only.
static void	setResponse(java.lang.String messageName, VIBMessageBean message) Sets the response message by string
void	setSecsMsg(SecsMsg sm) Sets the raw secs message associated with this object.
void	setTriggerEdge(int triggerEdge) The edge that will trigger the message to be sent.
void	start() This is the true constructor.
java.lang.String	toJSONString() Create a JSON String that represents the class.
java.lang.String	toString() Create a toString to be proud of...

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, 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

Field Detail

ANY_CHANGE

public static final int ANY_CHANGE

Send the message on the whenever the value changes outside of the deadband. This is the default (and the VIB default).

See Also:

Constant Field Values

ERROR_STATUS_NAME

public static final java.lang.String ERROR_STATUS_NAME

This datasource will be triggered if an error response is recieved to a message.

See Also:

Constant Field Values

FALLING_EDGE

public static final int FALLING_EDGE

Only send the message on the FALLING edge. That is, if the value transistions from non-zero to zero (false to true).

See Also:

Constant Field Values

firstPublish

public boolean firstPublish

This is set for the first publish for each published item.

gemCompliant

public static boolean gemCompliant

Whether we are running with GEM compliance. This is false when we are running within the TransSECS editor, or if GEM compliance is not required.

GOOD_STATUS_NAME

public static final java.lang.String GOOD_STATUS_NAME

This datasource will be triggered if a good response is recieved to a message.

See Also:

Constant Field Values

RESPONSE_STATUS_NAME

public static final java.lang.String RESPONSE_STATUS_NAME

This is the name that we publish use to publish the received response. The name of the tool and the message (getControllerName and getName) are prepended. This datasource is triggered for both good and bad responses.

See Also:

Constant Field Values

RISING_EDGE

public static final int RISING_EDGE

Only send the message on the RISING edge. That is, if the value transistions from zero to non-zero (false to true).

See Also:

Constant Field Values

SEND_MESSAGE_NAME

public static final java.lang.String SEND_MESSAGE_NAME

This is the name that we publish use to send the. The name of the tool and the message (getControllerName and getName) are prepended.

See Also:

Constant Field Values

showThinking

public static boolean showThinking

Whether to show the logic of matching messages. This is turned on by the TransSECS development system.

transSecsController

public transient TransSecsController transSecsController

This is the transSecsController for this message bean.

Constructor Detail

VIBMessageBean

public VIBMessageBean()

Constructor. This registers this instance of this class.

Method Detail

addValueChangedListener

public void addValueChangedListener(java.lang.Object listener)

Creates a connector from the default outport of this server to the method called "valueInput" of the provided object. If the object passed does not have a "valueUpdate" method then addition of the listener is silently ignored. A "valueInput" method is a method called "valueInput" with a single argument that is a "ValueChangedEvent". This method does not update the target.

Overrides:

addValueChangedListener in class SimpleDataSource

Parameters:

listener - the target of this server

clearMessage

public SecsFormat00 clearMessage(SecsFormat00 mainList)

If the message is bi-directional, receiving the message will populate all the lists in the message with data. This messages will then be filled again as the message is created. This breaks the format completely. This method will clear all the SecsFormat00 of the message if the mainList has any elements.

Parameters:

mainList - if the mainlist has content - populated by receiving this message - all SecsFormat00 associated with this message will be cleared. The mainList will also be cleared.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Permit cloning of this instance so that we can test receiving without impacting the instance that is held by the controller.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

createMessage

public abstract SecsMsg createMessage()

Create the secs message. This is for subclasses. Send message will call this and send the returned message.

Specified by:

createMessage in interface SecsDefinedMessage

Returns:

the raw secs message object

createMessage

public SecsMsg createMessage(boolean detailedLogging)

Available to be overridden by subclasses to create a detailed SML string for logging. By default this just calls "createMessage"

Parameters:

detailedLogging - true if a detailed SML logging string should be created and added to the message

Returns:

See Also:

createMessage()

createMessageForDigitalTwin

public SecsMsg createMessageForDigitalTwin()

Create the secs message. This is for digital twins/simulation. Send message will call this and send the returned message.

createMessageForDigitalTwin

public SecsMsg createMessageForDigitalTwin(boolean detailedLogging)

Create the secs message. This is for digital twins/simulation. Send message will call this and send the returned message.

equals

public boolean equals(java.lang.Object obj)

Equals includes the name of the bean and the name of the controller. This avoids a problem when multiple controllers are used in one application.

Overrides:

equals in class java.lang.Object

getConnectOnSend

public boolean getConnectOnSend()

Returns connect on send. If this is true (the default) and there is no connection, then a connection will be attempted whenever this message is sent. If false, then no connectionn will be attempted. This is used when adding messages to a Voyeur Link.

getControllerName

public java.lang.String getControllerName()

Returns the message port name. This is the tool name.

getControllerPort

public int getControllerPort()

Returns the controller port. This is either the equipment or the host port.

getFunction

public abstract int getFunction()

Returns the function of this message.

Specified by:

getFunction in interface SecsDefinedMessage

getHcack

public int getHcack()

Used to determine if an autoresponse needs to be sent. Any value other than zero will prevent an auto resopnse.

Returns:

the hcack

getHostMessageErrorLists

public java.util.List<SecsFormat> getHostMessageErrorLists()

Returns:

the hostMessageErrorLists

getName

public java.lang.String getName()

This will return the name.

Overrides:

getName in class SimpleDataSource

Returns:

Returns the data source name.

getPeepOnly

public boolean getPeepOnly()

To take a look at the data in a message and then pass it on to the host without handling it set snoop only. TransSecs will process the message an publish the data, but it will not send a response and will not indicate within TransSecs that the message has been handled. All unhandled messages are passed to the Voyeur link if such a link exists. Note: If both an autoresponse and peep only is set then the auto response take precedence.

getPublishedAccessorContainer

public DataSourceContainer getPublishedAccessorContainer()
                                                  throws BadParameterException

Returns the container with the name of our controller.

Overrides:

getPublishedAccessorContainer in class PublishBean

Throws:

BadParameterException

getResponse

public SecsDefinedMessage getResponse()

Sets the response message by string

Specified by:

getResponse in interface SecsDefinedMessage

getResponse

public static VIBMessageBean getResponse(java.lang.String messageName)

Returns the response message by string

getResponseMessage

public VIBMessageBean getResponseMessage()

Sets the response message by string. Implemented by subclasses - default is to return null.

getResponseMessageName

public java.lang.String getResponseMessageName()

Sets the response message by string. Implemented by subclasses - default is to return null.

getSecsMsg

public SecsMsg getSecsMsg()

returns the raw secs message associated with this object.

Specified by:

getSecsMsg in interface SecsDefinedMessage

getStream

public abstract int getStream()

Returns the stream of this message.

Specified by:

getStream in interface SecsDefinedMessage

getTriggerEdge

public int getTriggerEdge()

The edge that will trigger the message to be sent. This should be one of the defined constants ANY_CHANGE, RISING_EDGE, FALLING_EDGE.

hashCode

public int hashCode()

The hashcode uses the name of the controller and the name of the bean. This avoids a problem when multiple controllers are used in one application.

Overrides:

hashCode in class java.lang.Object

hostMessageError

public void hostMessageError(java.lang.String cpname,
                             int cpack,
                             int hcack,
                             java.lang.String errorDescription)
                      throws java.lang.Exception

Indicate that an error has occured in processing a host message and create the error list if appropriate.

Parameters:

cpname - the cpname associated with the error

cpack - the error code.

Throws:

java.lang.Exception

hostMessageParameterMatchError

public boolean hostMessageParameterMatchError(SecsMsg hostMessage,
                                              java.util.Set<java.lang.String> matched,
                                              SecsFormat00 paramList,
                                              java.util.List<java.lang.String> expected)

Indicate that an error has occured in processing a host message and create the error list if appropriate.

Parameters:

cpname - the cpname associated with the error

cpack - the error code.

Returns:

always returns false - the return is ignored

init

public void init()
          throws BadParameterException

Add the event messages as CEIDs.

Overrides:

init in class DataSource

Throws:

BadParameterException

isGemCompliant

public static boolean isGemCompliant()

Returns:

the gemCompliant

isHandleAsHostMessage

public boolean isHandleAsHostMessage()

Returns:

the handleAsHostMessage

isHandleHostMessageErrors

public boolean isHandleHostMessageErrors()

Returns:

the handleHostMessageErrors

logInfo

public static void logInfo(java.lang.String message)

Log information about the reception of messages.

notifyReceive

public void notifyReceive()

Update all listeners to indicate that the message has been received.

println

public void println(java.lang.String s)

Prints out the provided string.

processMessage

public boolean processMessage(SecsMsg msg)

Process the response to the sent message - if any. This method should return true if it has handled the message, otherwise false.

Specified by:

processMessage in interface SecsDefinedMessage

publishData

public abstract boolean publishData(SecsMsg msg)

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

Specified by:

publishData in interface SecsDefinedMessage

receiveMessage

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

Process the response to the sent message. This is intended for subclasses.

Throws:

SecsException

receiveMessage

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

Process the response to the sent message. This is intended for subclasses.

Throws:

SecsException

receiveMessage

public boolean receiveMessage(SecsMsg sm,
                              boolean doPublish,
                              boolean logInfo,
                              java.lang.StringBuilder sml)
                       throws SecsException

Process the response to the sent message. This is intended for subclasses to generate the sml string.

Throws:

SecsException

receiveMessageForDigitalTwin

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

Process the response to the sent message. This is intended for simulation/digital twin.

Throws:

SecsException

removeValueChangedListener

public void removeValueChangedListener(java.lang.Object listener)

Creates a connector from the default outport of this server to the method called "valueInput" of the provided object. If the object passed does not have a "valueUpdate" method then addition of the listener is silently ignored. A "valueInput" method is a method called "valueInput" with a single argument that is a "ValueChangedEvent". This method does not update the target.

Overrides:

removeValueChangedListener in class SimpleDataSource

Parameters:

listener - the target of this server

resetAutoResponseTable

public static void resetAutoResponseTable()

responseReceived

public boolean responseReceived(int status,
                                SecsMsg primary,
                                SecsMsg response)

The MsgResponseInterface. This will set the value of the manipulator to be the status of the message.

Specified by:

responseReceived in interface MessageResponseInterface

sendErrorResponse

public boolean sendErrorResponse(SecsMsg hostMessage,
                                 boolean defaultReturn)

Send the S2F42 if appropriate. This will only send errors. If a good reply is required that should be handled in the normal manner. If this message is not handling errors no message will be sent and "false" will be returned.

Parameters:

hostMessage - the host message that is being processed.

defaultReturn - returned if no message is sent

Returns:

true if the message is handled and a response sent, otherwise false.

sendMessage

public SecsMsg sendMessage()
                    throws SecsException

Send the message. This will call the subclasses createMessage method and then send the created message through the correct connection.

Specified by:

sendMessage in interface SecsDefinedMessage

Returns:

the raw secs message object that was received as the reply. This could be null in the case of T3 or if the messages does not have a reply.

Throws:

SecsException

sendMessage

public SecsMsg sendMessage(int deviceId)
                    throws SecsException

Send the message. This will call the subclasses createMessage method and then send the created message through the correct connection.

Throws:

SecsException

sendMessage

public void sendMessage(java.lang.Object delegate)
                 throws SecsException

Sends the message and notify the delegate when the response is recevied. Use only for primaries.

Throws:

SecsException

sendMessage

public void sendMessage(ValueChangedEvent newEvent)
                 throws VIBUpdateFailedException

This method will send the message. The messsage will be sent if the transition matches the "triggerEdge" parameter. By default, the message will be sent on all transitions.

Throws:

VIBUpdateFailedException

sendMessageAndWait

public <T extends VIBMessageBean> T sendMessageAndWait()
                                                throws SecsException

Sends the message and waits for the response. The value returned is the status of the message reponse. Don't use this method if the message does not expect a reply. Use only for primaries.

Throws:

SecsException

sendMessageAndWait

public <T extends VIBMessageBean> T sendMessageAndWait(int deviceId)
                                                throws SecsException

Sends the message and waits for the response. The value returned is the status of the message response. Don't use this method if the message does not expect a reply. Use only for primaries.

Throws:

SecsException

sendMessageFromOPC

public void sendMessageFromOPC()
                        throws java.lang.Exception

Send a message from an OPC server. This is part of the VIBMessageBeanOPCInterface that avoids pulling in dependencies.

Throws:

java.lang.Exception

setConnectOnSend

public void setConnectOnSend(boolean connectOnSend)

Sets connect on send. If this is true (the default) and there is no connection, then a connection will be attempted whenever this message is sent. If false, then no connectionn will be attempted. This is used when adding messages to a Voyeur Link.

setControllerName

public void setControllerName(java.lang.String controllerName)

Sets the controller name. This is an arbitrary name used to identify the port if it is required to send messages to different port.

setControllerPort

public void setControllerPort(int controllerPort)

Sets the controller port. This is either the equipment or the host port.

setGemCompliant

public static void setGemCompliant(boolean gemCompliant)

Parameters:

gemCompliant - the gemCompliant to set

setHandleAsHostMessage

public void setHandleAsHostMessage(boolean handleAsHostMessage)

Parameters:

handleAsHostMessage - the handleAsHostMessage to set

setHandleHostMessageErrors

public void setHandleHostMessageErrors(boolean handleHostMessageErrors)

Parameters:

handleHostMessageErrors - the handleHostMessageErrors to set

setHcack

public void setHcack(int hcack)

Used in the generated code to set the variable.

Parameters:

hcack - the hcack to set

setHostMessageErrorLists

public void setHostMessageErrorLists(java.util.List<SecsFormat> hostMessageErrorLists)

Parameters:

hostMessageErrorLists - the hostMessageErrorLists to set

setName

public void setName(java.lang.String newName)
             throws BadParameterException

Set the name of this component. This is just the name of the message. This will also modify the datasourcename of this component to be the name of the component to toolname.newName.sendMessage.

Overrides:

setName in class SimpleDataSource

Parameters:

newName - toolname.msgname

Throws:

BadParameterException - thrown if a component by the same name is already registered.

See Also:

SimpleDataSource.setName(java.lang.String)

setPeepOnly

public void setPeepOnly(boolean peepOnly)

To take a look at the data in a message and then pass it on to the host without handling it set snoop only. TransSecs will process the message an publish the data, but it will not send a response and will not indicate within TransSecs that the message has been handled. All unhandled messages are passed to the Voyeur link if such a link exists. Note: If both an autoresponse and peep only is set then the auto response take precedence.

setResponse

public static void setResponse(java.lang.String messageName,
                               VIBMessageBean message)

Sets the response message by string

setSecsMsg

public void setSecsMsg(SecsMsg sm)

Sets the raw secs message associated with this object.

setTriggerEdge

public void setTriggerEdge(int triggerEdge)

The edge that will trigger the message to be sent. This should be one of the defined constants ANY_CHANGE, RISING_EDGE, FALLING_EDGE.

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

This is the true constructor. This happens after the subclasses init method is called. This will find the transSecsController for the subclass and create one if this it can't find one.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

toJSONString

public java.lang.String toJSONString()

Create a JSON String that represents the class. This is a map of published names with their values express in JSON. For example, { "AllParams": { "values": [ { "value":"START", "type":20 }, { "values": [ { "values": [ { "value":"PPID", "type":20 }, { "value":"something", "type":20 } ] } ] } ] }, "Command": { "value":"START", "type":20 }, "CommandParams":{ "values": [ { "values": [ { "value":"PPID", "type":20 }, { "value":"something", "type":20 } ] } ]}, "Parm1List":{ "values": [ { "value":"PPID", "type":20 }, { "value":"something", "type":20 } ] }, "CPName":{ "value":"PPID", "type":20 }, "CPVal":{ "value":"something", "type":20 } }

Returns:

a JSON representation of the message.

toString

public java.lang.String toString()

Create a toString to be proud of...

Overrides:

toString in class Manipulator

Returns:

a string description of this server