TransSecsController (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.transsecs.secs.TransSecsController

Direct Known Subclasses:

TransSecsControllerDevicesClient, TransSecsControllerOPCClient, TransSecsVoyeur
```
public class TransSecsController
extends java.lang.Object
```
This is the main host controller for TransSECS. This creates a passive connection (or SECSI equipment link) and will listen for connections. If you need an active connection, the TransSecsVoyeur provides this with an optional passive connection to a real host and pass through.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TransSecsController.ResponseWrapper
Register with the message bean and then calls the messageReceived.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TransSecsController.ResponseWrapper` Register with the message bean and then calls the messageReceived.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTIVE_PORT` The host port.
`static java.util.HashMap<VIBMessageBean,com.ergotech.transsecs.secs.InstanceStorage>`	`allInstances` The hashtable of instances.
`ConnectionConfig`	`connectionConfig` A convenient place for subclasses to save this if they need it.
`static java.lang.String`	`csvFolder` The folder in which optional CSV files are stored.
`static int`	`debugLevel` The debug level for this object.
`static int`	`DEFAULT_TRANSSECS_APPLICATION` Application types.
`static java.lang.Object`	`defaultMessageHandler` The default message handler to use.
`static int`	`DEVICES_CLIENT_TRANSSECS_APPLICATION` Application types.
`static int`	`FILE_RECIPE_MANAGER` File Recipe Manager type.
`static boolean`	`invertHostOrEquipmentConnection` Set to true if want to simulate the equipment from files generated for the host or the host if generated for the equipment.
`VIBMessageBean`	`lastProcessed` The last message that was processed.
`static int`	`PASSIVE_PORT` The equipment port.
`static boolean`	`passThroughGlobal` True if the application is configured as a pass-through application.
`BroadcastServer`	`recipeBaseDir` This server is used by a FileRecipeManager to set the base directory of the file.
`BroadcastServer`	`recipeFileExtension` This server is used by a FileRecipeManager to set the extension of the file.
`RecipeManagerInterface`	`recipeManager` This is the recipe manager for this controller.
`static int`	`recipeManagerType` This is the recipe manager type.
`static TestPanelInterface`	`testPanel` The test panel.
`static int`	`transSecsApplicationType` Provides a type for the transecs application.

Constructor Summary

Constructors
Constructor and Description

TransSecsController()
The bean constructor so that this bean can be used in development systems.

Constructors
Constructor and Description
`TransSecsController()` The bean constructor so that this bean can be used in development systems.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addALID(long alid, java.lang.String alidName, java.lang.String altx, int alcd, long setCEID, long clearCEID, java.lang.Object source)` The register method for ALIDs.
`void`	`addALID(long alid, java.lang.String alidName, java.lang.String altx, int alcd, long setCEID, long clearCEID, java.lang.Object source, java.util.List<SecsFormat> dvids)` The register method for ALIDs.
`void`	`addALIDsFromCSV(java.io.File csvFile)` Parse a csv file of ALIDs.
`void`	`addCEID(long ceid, java.lang.String name, java.lang.Object source)` The register method for CEIDs.
`void`	`addCEID(long ceid, java.lang.String name, java.lang.Object source, java.util.List<SecsFormat> dvids)` The register method for CEIDs.
`void`	`addCEIDsFromCSV(java.io.File csvFile)` Parse a csv file of CEIDs.
`void`	`addDependentEInterface(LifeCycle eInterface)` Add a dependent interface that will be lifecycled as part of this controller.
`void`	`addDVID(long svid, java.lang.String name, java.lang.String units, double limitMax, double limitMin, java.lang.String initialValue, int valueType, double deadband, long ceid, java.lang.Object source)` The register method for DVIDs/DVNAMEs.
`void`	`addECID(long ecid, java.lang.String name, java.lang.String units, double limitMax, double limitMin, java.lang.String initialValue, int valueType, double deadband, long ceid, java.lang.Object source)` The register method for ECIDs.
`void`	`addSVID(long svid, java.lang.String name, java.lang.String units, double limitMax, double limitMin, java.lang.String initialValue, int valueType, double deadband, long ceid, java.lang.Object source)` The register method for SVIDs.
`void`	`addVID(long vid, int idType, java.lang.String name, java.lang.String units, double limitMax, double limitMin, java.lang.String initialValue, int valueType, double deadband, long ceid, java.lang.Object source)` The register method for VIDs.
`void`	`addVIDsFromCSV(java.io.File csvFile)` Parse a csv file of VIDs.
`void`	`connect(boolean sendingMessage)` Connect to the equipment or listen for a connection from the host.
`static SecsFormat`	`createDataId(int format)` Return a unique unsigned data id .
`boolean`	`createDevices()` Return true if the ReferencedDevices needs to be instantiated.
`static SecsFormat3x5x`	`createSecsFormat3x5x(int format, long value)` Return the correct SecsFormat5x for the given type and value.
`void`	`destroy()` Destroy the component and destroy all the messages.
`void`	`disconnect()` Disconnects from all wrappers (active if present and passive).
`void`	`disconnectPassive()` Disconnect the passiveWrapper and generally clean up.
`static TransSecsController`	`findController(java.lang.String name)` Find a passiveWrapper for a given name.
`double`	`getActiveConnectionRetryInterval()` Frequency of connection attempt of all active connections.
`VIDBean`	`getAlids()`
`java.util.List<VIBMessageBean>`	`getAllMessages()` Returns a list of all messages
`java.util.List<VIBMessageBean>`	`getAutoResponseMessages()` Returns a list of messages to which we are expected to automatically respond.
`int`	`getBaudRate()` return the baud rate.
`VIDBean`	`getCeids()`
`java.lang.String`	`getClassPackage()` Returns the class package.
`ConnectionConfig`	`getConnectionConfig()`
`java.lang.String`	`getControllerName()` Returns the passive port name.
`int`	`getDeviceId()` Returns the device id for this equipment.
`WrapperInterface`	`getEquipmentWrapper()` Returns the only passiveWrapper we know about, the passive (equipment) passiveWrapper.
`boolean`	`getGemCompliant()` Returns the gem compliant.
`EquipmentControlInterface`	`getGemHandler()` Returns the gem handler, or null if we are not gem compliant.
`double`	`getLinkTestInterval()` The current link test interval for all HSMS connections
`int`	`getLocalDebug()` Returns the local debug level.
`LoggerInterface`	`getLogger()`
`VIBMessageBean`	`getMatchingPrimary(SecsMsg msg)` Returns the VIBMessageBean matching the system bytes of the provided SecsMsg or null if there is no matching message.
`VIBMessageBean`	`getMatchingResponse(SecsMsg msg)` Returns VIBMessageBean that represents the response to the SecsMsg provided or null if no response can be found.
`<T extends VIBMessageBean> T`	`getMessageBean(java.lang.String name)`
`double`	`getPassiveT1()`
`double`	`getPassiveT2()`
`double`	`getPassiveT3()`
`double`	`getPassiveT4()`
`int`	`getPassiveT5()`
`int`	`getPassiveT6()`
`int`	`getPassiveT7()`
`int`	`getPassiveT8()`
`java.lang.String`	`getPassiveToolTarget()` Returns the tool that will be the target.
`java.lang.String`	`getPersistenceFileName()` Return the file name for GEM persistence.
`int`	`getPort()` Returns the port that this object will use to listen for active connections.
`SimulationListener`	`getSimulationListener()` Return the simulation listener, creating if necessary.
`static TransSecsController`	`getSingleController()` Return the controller.
`java.util.Map<java.lang.Integer,VIBMessageBean>`	`getUnhandledPrimaries()`
`VIDBean`	`getVids()`
`WrapperInterface`	`getWrapper(int whichWrapper)` Returns a passiveWrapper for the give defined constant.
`static java.lang.String`	`getWrapperDescription(WrapperInterface wrapper)` Get the wrapper description.
`boolean`	`handleHandCraftedMessage(SecsMsg msg)`
`void`	`init()` Subclasses will fill in the data needed to make a connection.
`boolean`	`isAllowDuplicateSECSIMessages()` Returns true if the system bytes of the message do not need to be unique (mis-implemented SECSI messages).
`boolean`	`isDigitalTwin()`
`boolean`	`isPassThrough()`
`static boolean`	`isS1F3ReturnsValues()` The return will be true if the S1F3 method should return the values rather than the IDs.
`static void`	`logInfo(java.lang.String message)` Log4J log information about this component.
`VIBMessageBean`	`newInstance(java.lang.String className)` Returns a new instance of a class with the given name in the class package of this controller.
`void`	`println(java.lang.String s)` Prints out the provided string.
`boolean`	`processMessage(SecsMsg msg, int whichPort)` Iterate through the messages.
`boolean`	`processMessage(SecsMsg msg, SessionManager toSessionManager)` Process the message and send it to the appropriate wrapper.
`boolean`	`processMessage(SecsTrigger msg)` Process the message.
`static void`	`publish(java.lang.String toolName, java.lang.String tagName, ValueObjectInterface value)` Publish a VIB value object.
`void`	`publish(java.lang.String tagName, ValueObjectInterface value)` Publish a VIB value object.
`void`	`publishReport(SecsMsg incoming)` This will be called by a recieved report to publish all the VIDs.
`boolean`	`register()` This will attempt to register this EquipmentController as the EquipmentController for its name.
`void`	`registerEventComponents(VIBMessageBean source)` This will register all the RPTIDs and VID associated with a report message.
`boolean`	`registerForReceiveNotification(java.lang.String messageName, MessageNotifier messageReceivedInterface)` Register to be notified of the receipt of a specific message by name.
`static void`	`registerInstance(VIBMessageBean messageBean)` Register an instance of a VIBMessageBean.
`void`	`removeDependentEInterface(LifeCycle eInterface)` Remove a dependent interface
`boolean`	`sendResponse(VIBMessageBean msg, SecsMsg incoming)` /** This method will send a response to a received message.
`void`	`setActiveConnectionRetryInterval(double activeConnectionRetryInterval)` Sets the frequency of connection attempt of all active connections.
`void`	`setAllowDuplicateSECSIMessages(boolean allowDuplicateSECSIMessages)` Set to true if the system bytes of the message do not need to be unique (mis-implemented SECSI messages).
`void`	`setBaudRate(int baudRate)` set the baud rate.
`void`	`setClassPackage(java.lang.String classPackage)` Sets the class package name.
`void`	`setConnectionConfig(ConnectionConfig connectionConfig)`
`void`	`setControllerName(java.lang.String controllerName)` Sets the passive port name.
`void`	`setDeviceId(int deviceId)` Sets the device id for this equipment.
`void`	`setDigitalTwin(boolean digitalTwin)`
`void`	`setFileRecipeManagerExtension(java.lang.String ext)`
`void`	`setFileRecipeManagerPath(java.lang.String path)`
`void`	`setGemCompliant(boolean flag)` Sets the gem compliance.
`void`	`setLinkTestInterval(double linkTestInterval)` Sets a new link test interval for all HSMS connections
`void`	`setLocalDebug(int level)` Sets the local debug level.
`void`	`setLogger(LoggerInterface l)`
`void`	`setPassiveT1(double newValue)`
`void`	`setPassiveT2(double newValue)`
`void`	`setPassiveT3(double newValue)`
`void`	`setPassiveT4(double newValue)`
`void`	`setPassiveT5(int newValue)`
`void`	`setPassiveT6(int newValue)`
`void`	`setPassiveT7(int newValue)`
`void`	`setPassiveT8(int newValue)`
`void`	`setPassiveToolTarget(java.lang.String passiveToolTarget)` Sets the tool that will be the target.
`void`	`setPassiveWrapperClassName(java.lang.String passiveWrapperClassName)` Set the passive wrapper class name; only useful before connect is called
`void`	`setPassThrough(boolean passThrough)`
`void`	`setPersistenceFileName(java.lang.String persistenceFileName)` Set the file name for GEM persistence.
`void`	`setPort(int port)` Sets the port that this object will use to listen for active connections.
`static void`	`setS1F3ReturnsValues(boolean returnsValues)` Set to true if the S1F3 method should return the values when a blank list is passed to the method rather than the IDs.
`void`	`setSoftRevAndMDLN()` Allows subclasses to set parameters for S1F14 and S1F2.
`void`	`setT1(double newValue)`
`void`	`setT2(double newValue)`
`void`	`setT3(double newValue)`
`void`	`setT4(double newValue)`
`void`	`setT5(int newValue)`
`void`	`setT6(int newValue)`
`void`	`setT7(int newValue)`
`void`	`setT8(int newValue)`
`void`	`setupFileRecipeManager()`
`void`	`start()` Start the component.
`void`	`stop()` Stop the component.
`java.lang.String`	`toString()` Create a toString to be proud of...
`static void`	`unregisterInstance(VIBMessageBean messageBean)` Unregister an instance of a VIBMessageBean.
`void`	`valueInput(ValueChangedEvent event)` Sets the value for the given VID.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ACTIVE_PORT
```
public static final int ACTIVE_PORT
```
    The host port. Used to attach a message to a particular port of the TransSecsController.
    
    See Also:
    
    Constant Field Values
  - allInstances
```
public static java.util.HashMap<VIBMessageBean,com.ergotech.transsecs.secs.InstanceStorage> allInstances
```
    The hashtable of instances. The key to this hash table is the fully qualified class name. The value is an InstanceStorage object.
  - connectionConfig
```
public transient ConnectionConfig connectionConfig
```
    A convenient place for subclasses to save this if they need it.
  - csvFolder
```
public static java.lang.String csvFolder
```
    The folder in which optional CSV files are stored. This defaults to the system property user.dir.
  - debugLevel
```
public static int debugLevel
```
    The debug level for this object.
  - DEFAULT_TRANSSECS_APPLICATION
```
public static final int DEFAULT_TRANSSECS_APPLICATION
```
    Application types. Default.
    
    See Also:
    
    Constant Field Values
  - defaultMessageHandler
```
public static java.lang.Object defaultMessageHandler
```
    The default message handler to use. If this is null this object will be used as the message handler. This is here to allow the simulation frame to be the message handler and manually call processMessage on this class.
  - DEVICES_CLIENT_TRANSSECS_APPLICATION
```
public static final int DEVICES_CLIENT_TRANSSECS_APPLICATION
```
    Application types. OPC Client.
    
    See Also:
    
    Constant Field Values
  - FILE_RECIPE_MANAGER
```
public static final int FILE_RECIPE_MANAGER
```
    File Recipe Manager type.
    
    See Also:
    
    Constant Field Values
  - invertHostOrEquipmentConnection
```
public static boolean invertHostOrEquipmentConnection
```
    Set to true if want to simulate the equipment from files generated for the host or the host if generated for the equipment.
  - lastProcessed
```
public transient VIBMessageBean lastProcessed
```
    The last message that was processed. Will be null if no message matched on the last processMessage.
  - PASSIVE_PORT
```
public static final int PASSIVE_PORT
```
    The equipment port. Used to attach a message to a particular port of the TransSecsController.
    
    See Also:
    
    Constant Field Values
  - passThroughGlobal
```
public static boolean passThroughGlobal
```
    True if the application is configured as a pass-through application.
  - recipeBaseDir
```
public BroadcastServer recipeBaseDir
```
    This server is used by a FileRecipeManager to set the base directory of the file.
  - recipeFileExtension
```
public BroadcastServer recipeFileExtension
```
    This server is used by a FileRecipeManager to set the extension of the file.
  - recipeManager
```
public RecipeManagerInterface recipeManager
```
    This is the recipe manager for this controller. This may be null.
  - recipeManagerType
```
public static int recipeManagerType
```
    This is the recipe manager type.
  - testPanel
```
public static TestPanelInterface testPanel
```
    The test panel. May be null if no panel is defined.
  - transSecsApplicationType
```
public static int transSecsApplicationType
```
    Provides a type for the transecs application.
- Constructor Detail
  - TransSecsController
```
public TransSecsController()
```
    The bean constructor so that this bean can be used in development systems.
- Method Detail
  - addALID
```
public void addALID(long alid,
                    java.lang.String alidName,
                    java.lang.String altx,
                    int alcd,
                    long setCEID,
                    long clearCEID,
                    java.lang.Object source)
```
    The register method for ALIDs. public void registerALID (SecsFormat alid, String altx, byte alcd, int setCEID, int clearCEID);
  - addALID
```
public void addALID(long alid,
                    java.lang.String alidName,
                    java.lang.String altx,
                    int alcd,
                    long setCEID,
                    long clearCEID,
                    java.lang.Object source,
                    java.util.List<SecsFormat> dvids)
```
    The register method for ALIDs. public void registerALID (SecsFormat alid, String altx, byte alcd, int setCEID, int clearCEID);
  - addALIDsFromCSV
```
public void addALIDsFromCSV(java.io.File csvFile)
                     throws java.io.IOException
```
    Parse a csv file of ALIDs.
    
    Parameters:
    
    csvFileName - the name of the file containing the csv alid descriptions
    
    Throws:
    
    java.io.IOException - thrown if there is an error reading the file.
  - addCEID
```
public void addCEID(long ceid,
                    java.lang.String name,
                    java.lang.Object source)
```
    The register method for CEIDs.
  - addCEID
```
public void addCEID(long ceid,
                    java.lang.String name,
                    java.lang.Object source,
                    java.util.List<SecsFormat> dvids)
```
    The register method for CEIDs.
  - addCEIDsFromCSV
```
public void addCEIDsFromCSV(java.io.File csvFile)
                     throws java.io.IOException
```
    Parse a csv file of CEIDs.
    
    Parameters:
    
    csvFileName - the name of the file containing the csv ceid descriptions
    
    Throws:
    
    java.io.IOException - thrown if there is an error reading the file.
  - addDependentEInterface
```
public void addDependentEInterface(LifeCycle eInterface)
```
    Add a dependent interface that will be lifecycled as part of this controller.
    
    Parameters:
    
    eInterface - a dependent interface, for example, E40, E87, etc.
  - addDVID
```
public void addDVID(long svid,
                    java.lang.String name,
                    java.lang.String units,
                    double limitMax,
                    double limitMin,
                    java.lang.String initialValue,
                    int valueType,
                    double deadband,
                    long ceid,
                    java.lang.Object source)
```
    The register method for DVIDs/DVNAMEs.
  - addECID
```
public void addECID(long ecid,
                    java.lang.String name,
                    java.lang.String units,
                    double limitMax,
                    double limitMin,
                    java.lang.String initialValue,
                    int valueType,
                    double deadband,
                    long ceid,
                    java.lang.Object source)
```
    The register method for ECIDs. The ECID and accessorName are typically the same.
  - addSVID
```
public void addSVID(long svid,
                    java.lang.String name,
                    java.lang.String units,
                    double limitMax,
                    double limitMin,
                    java.lang.String initialValue,
                    int valueType,
                    double deadband,
                    long ceid,
                    java.lang.Object source)
```
    The register method for SVIDs.
  - addVID
```
public void addVID(long vid,
                   int idType,
                   java.lang.String name,
                   java.lang.String units,
                   double limitMax,
                   double limitMin,
                   java.lang.String initialValue,
                   int valueType,
                   double deadband,
                   long ceid,
                   java.lang.Object source)
```
    The register method for VIDs.
    
    Parameters:
    
    svid - the svid itself, must be an integer for GEM compliance, eg 30001
    
    idType - the type of the ID, should be one of SVID, ECID, DVID as defined in the GemEquipmentInterface.
    
    name - the name of the svid (used in some reports)
    
    initialValue - the initial value of the svid
    
    valueType - the type of the value, can be any SecsFormat valid for the ID type
    
    source - the object that is managing this value (probably a VIB manipulator)
    
    See Also:
    
    GemEquipmentInterface
  - addVIDsFromCSV
```
public void addVIDsFromCSV(java.io.File csvFile)
                    throws java.io.IOException
```
    Parse a csv file of VIDs.
    
    Parameters:
    
    csvFileName - the name of the file containing the csv vid descriptions
    
    Throws:
    
    java.io.IOException - thrown if there is an error reading the file.
  - connect
```
public void connect(boolean sendingMessage)
```
    Connect to the equipment or listen for a connection from the host. If the port number is < 128 then the connection is considered to be SECSI. If the isHost flag is set or the active host name is set, then we are then host and will try to connect to the equipment. This method is subclassed by the TransSecsVoyeur. In the voyeur there is always an active connection and, if a passive connection is set then there will be a pass through link created between the real host and the real equipment via a Voyeur link. If the boolean parameter is true, it will make make the connection (or if its set to autoconnect).
  - createDataId
```
public static SecsFormat createDataId(int format)
```
    Return a unique unsigned data id .
  - createDevices
```
public boolean createDevices()
```
    Return true if the ReferencedDevices needs to be instantiated. At development time this is not the case. At runtime the devices need to be created. We use the existance of the "devices" container as a flag for this.
    
    Returns:
  - createSecsFormat3x5x
```
public static SecsFormat3x5x createSecsFormat3x5x(int format,
                                                  long value)
```
    Return the correct SecsFormat5x for the given type and value. If the format is not 0, 1 or 2 a SecsFormat54 is returned.
    
    Parameters:
    
    format - 0,1,2,4 corresponding to the formats SecsFormat50, SecsFormat51, SecsFormat52, SecsFormat54
    
    value - the value to use when creating the SecsFormat.
    
    Returns:
  - destroy
```
public void destroy()
             throws BadParameterException
```
    Destroy the component and destroy all the messages.
    
    Throws:
    
    BadParameterException
  - disconnect
```
public void disconnect()
```
    Disconnects from all wrappers (active if present and passive).
  - disconnectPassive
```
public void disconnectPassive()
```
    Disconnect the passiveWrapper and generally clean up.
  - findController
```
public static TransSecsController findController(java.lang.String name)
```
    Find a passiveWrapper for a given name.
  - getActiveConnectionRetryInterval
```
public double getActiveConnectionRetryInterval()
```
    Frequency of connection attempt of all active connections.
    
    Returns:
    
    the connection attempt frequency in seconds.
  - getAlids
```
public VIDBean getAlids()
```
    Returns:
    
    the alids
  - getAllMessages
```
public java.util.List<VIBMessageBean> getAllMessages()
```
    Returns a list of all messages
  - getAutoResponseMessages
```
public java.util.List<VIBMessageBean> getAutoResponseMessages()
```
    Returns a list of messages to which we are expected to automatically respond. This is implemented automatically in generated code for each tool, however, if someone drop an instance of this class on the screen then it will still work. In this case, we get the subclass, instantiate it and return the Vector from its implementation of getAutoResponseMessages.
  - getBaudRate
```
public int getBaudRate()
```
    return the baud rate.
    
    Returns:
    
    the baud rate
  - getCeids
```
public VIDBean getCeids()
```
    Returns:
    
    the ceids
  - getClassPackage
```
public java.lang.String getClassPackage()
```
    Returns the class package.
  - getConnectionConfig
```
public ConnectionConfig getConnectionConfig()
```
  - getControllerName
```
public java.lang.String getControllerName()
```
    Returns the passive port name. This is an arbitrary name used to identify the port if it is required to send messages to different port.
  - getDeviceId
```
public int getDeviceId()
```
    Returns the device id for this equipment.
  - getEquipmentWrapper
```
public WrapperInterface getEquipmentWrapper()
```
    Returns the only passiveWrapper we know about, the passive (equipment) passiveWrapper. This is the passiveWrapper that listens for connections from the host.
  - getGemCompliant
```
public boolean getGemCompliant()
```
    Returns the gem compliant.
  - getGemHandler
```
public EquipmentControlInterface getGemHandler()
```
    Returns the gem handler, or null if we are not gem compliant.
  - getLinkTestInterval
```
public double getLinkTestInterval()
```
    The current link test interval for all HSMS connections
    
    Returns:
    
    the current link test interval
  - getLocalDebug
```
public int getLocalDebug()
```
    Returns the local debug level.
  - getLogger
```
public LoggerInterface getLogger()
```
  - getMatchingPrimary
```
public VIBMessageBean getMatchingPrimary(SecsMsg msg)
```
    Returns the VIBMessageBean matching the system bytes of the provided SecsMsg or null if there is no matching message.
  - getMatchingResponse
```
public VIBMessageBean getMatchingResponse(SecsMsg msg)
```
    Returns VIBMessageBean that represents the response to the SecsMsg provided or null if no response can be found. This method will search the unhandledPrimaries hashtable for the VIBMessageBean that sent the primary and then call getResponse on the primary to get the response message.
  - getMessageBean
```
public <T extends VIBMessageBean> T getMessageBean(java.lang.String name)
                                            throws BadParameterException
```
    Throws:
    
    BadParameterException
  - getPassiveT1
```
public double getPassiveT1()
```
  - getPassiveT2
```
public double getPassiveT2()
```
  - getPassiveT3
```
public double getPassiveT3()
```
  - getPassiveT4
```
public double getPassiveT4()
```
  - getPassiveT5
```
public int getPassiveT5()
```
  - getPassiveT6
```
public int getPassiveT6()
```
  - getPassiveT7
```
public int getPassiveT7()
```
  - getPassiveT8
```
public int getPassiveT8()
```
  - getPassiveToolTarget
```
public java.lang.String getPassiveToolTarget()
```
    Returns the tool that will be the target. This is used by Y-Tap connections to allow all messages to be passed from one connection to another. This target is the name of a TransSECSController not a host or port name.
  - getPersistenceFileName
```
public java.lang.String getPersistenceFileName()
```
    Return the file name for GEM persistence.
    
    Returns:
    
    the gem persistence file name
  - getPort
```
public int getPort()
```
    Returns the port that this object will use to listen for active connections.
  - getSimulationListener
```
public SimulationListener getSimulationListener()
```
    Return the simulation listener, creating if necessary.
    
    Returns:
    
    the simulation listener
  - getSingleController
```
public static TransSecsController getSingleController()
```
    Return the controller. If multiple controllers have been registered this method will return one controller. Which controller is undefined and so this method should not be used if multiple controller have been registered.
  - getUnhandledPrimaries
```
public java.util.Map<java.lang.Integer,VIBMessageBean> getUnhandledPrimaries()
```
    Returns:
    
    the unhandledPrimaries
  - getVids
```
public VIDBean getVids()
```
    Returns:
    
    the vids
  - getWrapper
```
public WrapperInterface getWrapper(int whichWrapper)
```
    Returns a passiveWrapper for the give defined constant.
  - getWrapperDescription
```
public static java.lang.String getWrapperDescription(WrapperInterface wrapper)
```
    Get the wrapper description.
  - handleHandCraftedMessage
```
public boolean handleHandCraftedMessage(SecsMsg msg)
```
  - init
```
public void init()
          throws BadParameterException
```
    Subclasses will fill in the data needed to make a connection. This is done before the connect. THIS MUST NOT CALL CONNECT! That will be done after the init is called. Subclasses should fill in all information to be able to make a connection, but NEVER connect. Allso calls "init" on all the beans.
    
    Throws:
    
    BadParameterException
  - isAllowDuplicateSECSIMessages
```
public boolean isAllowDuplicateSECSIMessages()
```
    Returns true if the system bytes of the message do not need to be unique (mis-implemented SECSI messages).
    
    Returns:
    
    true if duplicate system bytes are permitted.
  - isDigitalTwin
```
public boolean isDigitalTwin()
```
    Returns:
    
    the digitalTwin
  - isPassThrough
```
public boolean isPassThrough()
```
  - isS1F3ReturnsValues
```
public static boolean isS1F3ReturnsValues()
```
    The return will be true if the S1F3 method should return the values rather than the IDs. IDs is compliant with the specification.
    
    Returns:
    
    the value of the S1F3ReturnsValues variable
  - logInfo
```
public static void logInfo(java.lang.String message)
```
    Log4J log information about this component.
  - newInstance
```
public VIBMessageBean newInstance(java.lang.String className)
```
    Returns a new instance of a class with the given name in the class package of this controller. The class is instantiated from the current class loader.
    
    Parameters:
    
    className - the name of the class to instantiate
    
    Returns:
  - println
```
public void println(java.lang.String s)
```
    Prints out the provided string.
  - processMessage
```
public boolean processMessage(SecsMsg msg,
                              int whichPort)
```
    Iterate through the messages. Returns true if one matches otherwise false. The messages are handled as follows:
    Recieved Primary (no autoresponse) this must be put on a screen and quick connected to the response. Recieved Primary (with autoresponse) this can be put on a screen and used to recieve a notification of the received message but is never quick connected to the response. Recieved Secondary this is never put on the screen. It is published from an instance that is newly created each time the message is received. It could be imagined that it is processed by the primary (which it is). Sent SecondaryNever comes through this method, but for completeness is put on the screen and triggered by a received primary that does not have an autoresponse.
  - processMessage
```
public boolean processMessage(SecsMsg msg,
                              SessionManager toSessionManager)
```
    Process the message and send it to the appropriate wrapper.
  - processMessage
```
public boolean processMessage(SecsTrigger msg)
```
    Process the message. This called processMessage (msg, PASSIVE_PORT )
  - publish
```
public static void publish(java.lang.String toolName,
                           java.lang.String tagName,
                           ValueObjectInterface value)
```
    Publish a VIB value object.
    
    Parameters:
    
    toolName - the name of the tool (may be null)
    
    tagName - the assigned named of the value being published
    
    value - the value being published
  - publish
```
public void publish(java.lang.String tagName,
                    ValueObjectInterface value)
```
    Publish a VIB value object.
    
    Parameters:
    
    tagName - the assigned named of the value being published
    
    value - the value being published
  - publishReport
```
public void publishReport(SecsMsg incoming)
```
    This will be called by a recieved report to publish all the VIDs.
  - register
```
public boolean register()
```
    This will attempt to register this EquipmentController as the EquipmentController for its name. It will then call connect to make sure the connection takes hold. This should be called AFTER init(); NOTE: This can happen more then
  - registerEventComponents
```
public void registerEventComponents(VIBMessageBean source)
```
    This will register all the RPTIDs and VID associated with a report message. It is called from "addCEID" when a report is first created. The reason to do this is to ensure that is someone creates an event message in TransSECS they can then use this CEID as a true GEM CEID. That is, that they can add reports, remove reports, enable/disable the CEID, etc. etc.
  - registerForReceiveNotification
```
public boolean registerForReceiveNotification(java.lang.String messageName,
                                              MessageNotifier messageReceivedInterface)
```
    Register to be notified of the receipt of a specific message by name.
  - registerInstance
```
public static void registerInstance(VIBMessageBean messageBean)
```
    Register an instance of a VIBMessageBean. Any bean that needs to be notified of message reception will be registered. A bean needs to be notified of message reception if it has been attached to another bean that is listening for it. In other word, this register occurs on the "addListener" method of VIBMessageBean.
  - removeDependentEInterface
```
public void removeDependentEInterface(LifeCycle eInterface)
```
    Remove a dependent interface
    
    Parameters:
    
    eInterface - a dependent interface, for example, E40, E87, etc.
  - sendResponse
```
public boolean sendResponse(VIBMessageBean msg,
                            SecsMsg incoming)
```
    /** This method will send a response to a received message.
    
    Parameters:
    
    msg - the incoming message.
    
    Returns:
    
    the raw secs message sent.
  - setActiveConnectionRetryInterval
```
public void setActiveConnectionRetryInterval(double activeConnectionRetryInterval)
```
    Sets the frequency of connection attempt of all active connections.
    
    Parameters:
    
    activeConnectionRetryInterval - the connection attempt frequency in seconds.
  - setAllowDuplicateSECSIMessages
```
public void setAllowDuplicateSECSIMessages(boolean allowDuplicateSECSIMessages)
```
    Set to true if the system bytes of the message do not need to be unique (mis-implemented SECSI messages).
    
    Parameters:
    
    allowDuplicateSECSIMessages - set to true if duplicate system bytes are permitted.
  - setBaudRate
```
public void setBaudRate(int baudRate)
```
    set the baud rate.
  - setClassPackage
```
public void setClassPackage(java.lang.String classPackage)
```
    Sets the class package name.
  - setConnectionConfig
```
public void setConnectionConfig(ConnectionConfig connectionConfig)
```
  - setControllerName
```
public void setControllerName(java.lang.String controllerName)
```
    Sets the passive port name. This is an arbitrary name used to identify the port if it is required to send messages to different port.
  - setDeviceId
```
public void setDeviceId(int deviceId)
```
    Sets the device id for this equipment.
  - setDigitalTwin
```
public void setDigitalTwin(boolean digitalTwin)
```
    Parameters:
    
    digitalTwin - the digitalTwin to set
  - setFileRecipeManagerExtension
```
public void setFileRecipeManagerExtension(java.lang.String ext)
```
  - setFileRecipeManagerPath
```
public void setFileRecipeManagerPath(java.lang.String path)
```
  - setGemCompliant
```
public void setGemCompliant(boolean flag)
```
    Sets the gem compliance.
  - setLinkTestInterval
```
public void setLinkTestInterval(double linkTestInterval)
```
    Sets a new link test interval for all HSMS connections
    
    Parameters:
    
    linkTestInterval - the new link test interval
  - setLocalDebug
```
public void setLocalDebug(int level)
```
    Sets the local debug level.
  - setLogger
```
public void setLogger(LoggerInterface l)
```
  - setPassiveT1
```
public void setPassiveT1(double newValue)
```
  - setPassiveT2
```
public void setPassiveT2(double newValue)
```
  - setPassiveT3
```
public void setPassiveT3(double newValue)
```
  - setPassiveT4
```
public void setPassiveT4(double newValue)
```
  - setPassiveT5
```
public void setPassiveT5(int newValue)
```
  - setPassiveT6
```
public void setPassiveT6(int newValue)
```
  - setPassiveT7
```
public void setPassiveT7(int newValue)
```
  - setPassiveT8
```
public void setPassiveT8(int newValue)
```
  - setPassiveToolTarget
```
public void setPassiveToolTarget(java.lang.String passiveToolTarget)
```
    Sets the tool that will be the target. This is used by Y-Tap connections to allow all messages to be passed from one connection to another. This target is the name of a TransSECSController not a host or port name.
  - setPassiveWrapperClassName
```
public void setPassiveWrapperClassName(java.lang.String passiveWrapperClassName)
```
    Set the passive wrapper class name; only useful before connect is called
  - setPassThrough
```
public void setPassThrough(boolean passThrough)
```
  - setPersistenceFileName
```
public void setPersistenceFileName(java.lang.String persistenceFileName)
```
    Set the file name for GEM persistence. This may include absolute or relative paths but the directory must exist.
    
    Parameters:
    
    persistenceFileName - the gem persistence file name
  - setPort
```
public void setPort(int port)
```
    Sets the port that this object will use to listen for active connections.
  - setS1F3ReturnsValues
```
public static void setS1F3ReturnsValues(boolean returnsValues)
```
    Set to true if the S1F3 method should return the values when a blank list is passed to the method rather than the IDs. NOTE: Setting this value to true is a violation of the SECS specification which calls for the SVIDs to be returned by the S1F3
    
    Parameters:
    
    returnsValues - the S1F3ReturnsValues parameter
  - setSoftRevAndMDLN
```
public void setSoftRevAndMDLN()
```
    Allows subclasses to set parameters for S1F14 and S1F2.
  - setT1
```
public void setT1(double newValue)
```
  - setT2
```
public void setT2(double newValue)
```
  - setT3
```
public void setT3(double newValue)
```
  - setT4
```
public void setT4(double newValue)
```
  - setT5
```
public void setT5(int newValue)
```
  - setT6
```
public void setT6(int newValue)
```
  - setT7
```
public void setT7(int newValue)
```
  - setT8
```
public void setT8(int newValue)
```
  - setupFileRecipeManager
```
public void setupFileRecipeManager()
                            throws BadParameterException,
                                   VIBUpdateFailedException
```
    Throws:
    
    BadParameterException
    
    VIBUpdateFailedException
  - start
```
public void start()
           throws BadParameterException,
                  VIBUpdateFailedException
```
    Start the component. Put all the messages in a container and call start on them.
    
    Throws:
    
    BadParameterException
    
    VIBUpdateFailedException
  - stop
```
public void stop()
          throws BadParameterException
```
    Stop the component. Remove all the messages from their container and call stop on them.
    
    Throws:
    
    BadParameterException
  - toString
```
public java.lang.String toString()
```
    Create a toString to be proud of...
    
    Overrides:
    
    toString in class java.lang.Object
  - unregisterInstance
```
public static void unregisterInstance(VIBMessageBean messageBean)
```
    Unregister an instance of a VIBMessageBean.
  - valueInput
```
public void valueInput(ValueChangedEvent event)
                throws VIBUpdateFailedException
```
    Sets the value for the given VID. If the VID is registered with this object using the addECID or addSVID method then this method will send the value on to that object. The object that is registered is probably an object created by TransSECS. The object that is updating is probably a VID server that someone has put on the VIB display. Since the TransSECS object represents a message that can be sent it must always have the latest value, even if this is a duplicate of the object on the screen.
    
    Throws:
    
    VIBUpdateFailedException

Class TransSecsController

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTIVE_PORT

allInstances

connectionConfig

csvFolder

debugLevel

DEFAULT_TRANSSECS_APPLICATION

defaultMessageHandler

DEVICES_CLIENT_TRANSSECS_APPLICATION

FILE_RECIPE_MANAGER

invertHostOrEquipmentConnection

lastProcessed

PASSIVE_PORT

passThroughGlobal

recipeBaseDir

recipeFileExtension

recipeManager

recipeManagerType

testPanel

transSecsApplicationType

Constructor Detail

TransSecsController

Method Detail

addALID

addALID

addALIDsFromCSV

addCEID

addCEID

addCEIDsFromCSV

addDependentEInterface

addDVID

addECID

addSVID

addVID

addVIDsFromCSV

connect

createDataId

createDevices

createSecsFormat3x5x

destroy

disconnect

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

getSimulationListener