SecsIWrapper (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.SecsIWrapper

All Implemented Interfaces:

SecsEventListener, WrapperInterface, java.io.Serializable, java.util.EventListener

Direct Known Subclasses:

TerminalServerWrapper
```
public class SecsIWrapper
extends java.lang.Object
implements WrapperInterface, SecsEventListener
```
This is the wrapper for the SECSI interface. It contains all the information required to create and maintain a SECSI Connection.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.Class<?> portManagerFactoryClass
The port manager factory class.
- Fields inherited from interface com.ergotech.secs.WrapperInterface
  cvsRev

Fields
Modifier and Type	Field and Description
`static java.lang.Class<?>`	`portManagerFactoryClass` The port manager factory class.

Constructor Summary

Constructors
Constructor and Description

SecsIWrapper(int port, int deviceId)
The constructor.

Constructors
Constructor and Description
`SecsIWrapper(int port, int deviceId)` The constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessageHandler(java.lang.Object messageHandler)` Add a message handler object.
`void`	`addMessageHandler(java.io.Serializable messageHandler)` Add a message handler object.
`boolean`	`connect()` Connected the session.
`void`	`destroy()`
`void`	`disconnect()` Disconnect the connection.
`boolean`	`getAllowDuplicateMessages()` If this flag is set then duplicate messages will be passed through as if they were not duplicate.
`int`	`getBaudRate()` Returns the current baud rate.
`static boolean`	`getDefaultAllowDuplicateMessages()` If this flag is set then duplicate messages will be passed through as if they were not duplicate.
`int`	`getDeviceId()` Returns the default device Id.
`boolean`	`getIsHost()` Returns whether this connection is host or equipment.
`LoggerInterface`	`getLogger()` Returns the current logger.
`java.util.List<java.lang.Object>`	`getMessageHandlers()` Return the List of all the message handlers.
`int`	`getPort()` Returns the current TCP/IP port.
`PortManager`	`getPortManager()` Returns the port manager for the wrapper.
`PortManager`	`getPortManager(boolean search)` Returns the port manager for the wrapper.
`SessionManager`	`getRawSessionManager(int deviceId)` Get a session manager for the provided deviceID.
`int`	`getRetryLimit()` Returns the retry limit.
`SessionManager`	`getSessionManager()` This will return the current SessionManager if one exists.
`SessionManager`	`getSessionManager(int deviceId)` Get a session manager for the provided deviceID.
`double`	`getT1()` Returns the T1 timeout value.
`double`	`getT2()` Returns the T2 timeout value.
`double`	`getT3()` Returns the T3 timeout value.
`double`	`getT4()` Returns the T4 timeout value.
`void`	`init()`
`boolean`	`initializeConnection()` Connect the connection.
`void`	`removeMessageHandler(java.lang.Object messageHandler)` Remove a message handler object.
`void`	`secsEvent(SecsEvent theEvent)` Catches incoming PORT_ERROR events and removes the portManager.
`void`	`setAllowDuplicateMessages(boolean allowDuplicateMessages)` If this flag is set then duplicate messages will be passed through as if they were not duplicate.
`void`	`setBaudRate(int newValue)` Sets the baudrate for the current connection.
`void`	`setDefault(boolean flag)` Determines whether newly created sessions should be set to the default session.
`static void`	`setDefaultAllowDuplicateMessages(boolean defaultAllowDuplicateMessages)` If this flag is set then duplicate messages will be passed through as if they were not duplicate.
`void`	`setDeviceId(int deviceId)` Sets the default device ID.
`void`	`setIsHost(boolean newValue)` Controls whether this connection is host or equipment.
`void`	`setLogger(LoggerInterface theLogger)` Sets the logger for the current connection.
`void`	`setPort(int port)` Set the serial port to listen on.
`void`	`setPortManager(PortManager pm)` Sets the port manager for the wrapper.
`void`	`setRetryLimit(int newValue)` Sets the retry limit.
`void`	`setT1(double newValue)` Sets the T1 timeout value.
`void`	`setT2(double newValue)` Sets the T2 timeout value.
`void`	`setT3(double newValue)` Sets the T3 timeout value.
`void`	`setT4(double newValue)` Sets the T4 timeout value.
`void`	`start()`
`void`	`stop()`

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

Methods inherited from interface com.ergotech.secs.WrapperInterface
setActive

- Field Detail
  - portManagerFactoryClass
```
public static java.lang.Class<?> portManagerFactoryClass
```
    The port manager factory class. This defaults to SerialPortManager.class. It can be set to allow the wrapper to communicate over alternate transport layers. For example, this can be set to a class that support a terminal server operation.
- Constructor Detail
  - SecsIWrapper
```
public SecsIWrapper(int port,
                    int deviceId)
```
    The constructor.
    
    Parameters:
    
    port - the SECS1 serial port to use. This is an enumerated constant as described in the SerialPortManager object.
    
    See Also:
    
    SerialPortManager
- Method Detail
  - addMessageHandler
```
public void addMessageHandler(java.lang.Object messageHandler)
```
    Add a message handler object. This will be added to all future session managers that are created. It will not be added to existing session managers.
    
    Specified by:
    
    addMessageHandler in interface WrapperInterface
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - addMessageHandler
```
public void addMessageHandler(java.io.Serializable messageHandler)
```
    Add a message handler object. This will be added to all future session managers that are created. It will not be added to existing session managers.
    
    Specified by:
    
    addMessageHandler in interface WrapperInterface
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - connect
```
public boolean connect()
```
    Connected the session. Use initializeConnection instead it provides an exception indicating the reason for failure.
    
    Specified by:
    
    connect in interface WrapperInterface
  - destroy
```
public void destroy()
             throws BadParameterException
```
    Throws:
    
    BadParameterException
  - disconnect
```
public void disconnect()
```
    Disconnect the connection. This will close the connection and will cause all the objects associated with the connection to be garbage collected.
    
    Specified by:
    
    disconnect in interface WrapperInterface
  - getAllowDuplicateMessages
```
public boolean getAllowDuplicateMessages()
```
    If this flag is set then duplicate messages will be passed through as if they were not duplicate. This is for some old equipment that uses the same system bytes for all messages.
  - getBaudRate
```
public int getBaudRate()
```
    Returns the current baud rate. This value will not be correct if the baud rate of the port has been changed independently of this object.
    
    Returns:
    
    the current baud rate.
  - getDefaultAllowDuplicateMessages
```
public static boolean getDefaultAllowDuplicateMessages()
```
    If this flag is set then duplicate messages will be passed through as if they were not duplicate. This is for some old equipment that uses the same system bytes for all messages.
  - getDeviceId
```
public int getDeviceId()
```
    Returns the default device Id.
    
    Specified by:
    
    getDeviceId in interface WrapperInterface
    
    Returns:
    
    the device id.
  - getIsHost
```
public boolean getIsHost()
```
    Returns whether this connection is host or equipment.
    
    Returns:
    
    true if this connection is the host or slave.
  - getLogger
```
public LoggerInterface getLogger()
```
    Returns the current logger.
    
    Specified by:
    
    getLogger in interface WrapperInterface
    
    Returns:
    
    the current logger.
  - getMessageHandlers
```
public java.util.List<java.lang.Object> getMessageHandlers()
```
    Return the List of all the message handlers.
    
    Specified by:
    
    getMessageHandlers in interface WrapperInterface
  - getPort
```
public int getPort()
```
    Description copied from interface: WrapperInterface
    
    Returns the current TCP/IP port.
    
    Specified by:
    
    getPort in interface WrapperInterface
    
    Returns:
    
    the TCP/IP port.
  - getPortManager
```
public PortManager getPortManager()
```
    Returns the port manager for the wrapper. May be null if there is no connection.
    
    Specified by:
    
    getPortManager in interface WrapperInterface
    
    Returns:
    
    the port manager.
  - getPortManager
```
public PortManager getPortManager(boolean search)
```
    Returns the port manager for the wrapper. May be null if there is no connection.
    
    Parameters:
    
    search - if true this wrapper will try to find a port manager associated with this connection. If false, will just return the stored value (quite likely to be null)
    
    Returns:
    
    the port manager.
  - getRawSessionManager
```
public SessionManager getRawSessionManager(int deviceId)
                                    throws SecsException
```
    Get a session manager for the provided deviceID. If the session manager does not exist it will be created.
    
    Parameters:
    
    deviceId - the deviceId
    
    Throws:
    
    SecsException - if there are any problems.
  - getRetryLimit
```
public int getRetryLimit()
```
    Returns the retry limit.
    
    Returns:
    
    the retry limit
  - getSessionManager
```
public SessionManager getSessionManager()
```
    This will return the current SessionManager if one exists. Null if none exist.
    
    Specified by:
    
    getSessionManager in interface WrapperInterface
  - getSessionManager
```
public SessionManager getSessionManager(int deviceId)
```
    Get a session manager for the provided deviceID. If the session manager does not exist it will be created.
    
    Specified by:
    
    getSessionManager in interface WrapperInterface
    
    Parameters:
    
    deviceId - the deviceId
  - getT1
```
public double getT1()
```
    Returns the T1 timeout value.
    
    Returns:
    
    the T1 value
  - getT2
```
public double getT2()
```
    Returns the T2 timeout value.
    
    Returns:
    
    the T2 value
  - getT3
```
public double getT3()
```
    Returns the T3 timeout value.
    
    Specified by:
    
    getT3 in interface WrapperInterface
    
    Returns:
    
    the T3 value
  - getT4
```
public double getT4()
```
    Returns the T4 timeout value.
    
    Returns:
    
    the T4 value
  - init
```
public void init()
          throws BadParameterException
```
    Throws:
    
    BadParameterException
  - initializeConnection
```
public boolean initializeConnection()
                             throws SecsException
```
    Connect the connection.
    
    Specified by:
    
    initializeConnection in interface WrapperInterface
    
    Throws:
    
    SecsException
  - removeMessageHandler
```
public void removeMessageHandler(java.lang.Object messageHandler)
```
    Remove a message handler object.
    
    Specified by:
    
    removeMessageHandler in interface WrapperInterface
    
    Parameters:
    
    messageHandler - the message handler to add
    
    See Also:
    
    SecsMsg.processSelf(java.lang.Object)
  - secsEvent
```
public void secsEvent(SecsEvent theEvent)
```
    Catches incoming PORT_ERROR events and removes the portManager.
    
    Specified by:
    
    secsEvent in interface SecsEventListener
  - setAllowDuplicateMessages
```
public void setAllowDuplicateMessages(boolean allowDuplicateMessages)
```
    If this flag is set then duplicate messages will be passed through as if they were not duplicate. This is for some old equipment that uses the same system bytes for all messages.
  - setBaudRate
```
public void setBaudRate(int newValue)
```
    Sets the baudrate for the current connection. This change will occur immediately if there is a connection.
    
    Parameters:
    
    newValue - the new baud rate.
  - setDefault
```
public void setDefault(boolean flag)
```
    Determines whether newly created sessions should be set to the default session. NOTE: Default is true.
    
    Specified by:
    
    setDefault in interface WrapperInterface
    
    Parameters:
    
    flag - true if created session should be made the default session.
    
    See Also:
    
    SessionManager.setDefault()
  - setDefaultAllowDuplicateMessages
```
public static void setDefaultAllowDuplicateMessages(boolean defaultAllowDuplicateMessages)
```
    If this flag is set then duplicate messages will be passed through as if they were not duplicate. This is for some old equipment that uses the same system bytes for all messages.
  - setDeviceId
```
public void setDeviceId(int deviceId)
```
    Sets the default device ID.
    
    Specified by:
    
    setDeviceId in interface WrapperInterface
    
    Parameters:
    
    deviceId - the default device Id.
    
    See Also:
    
    getDeviceId.
  - setIsHost
```
public void setIsHost(boolean newValue)
```
    Controls whether this connection is host or equipment. Setting this after the connection has been formed will have
    
    Parameters:
    
    newValue - set to true to make this connection the host or slave.
  - setLogger
```
public void setLogger(LoggerInterface theLogger)
```
    Sets the logger for the current connection. This logger will be added to all future sessions created, it will not be set to existing sessions.
    
    Specified by:
    
    setLogger in interface WrapperInterface
    
    Parameters:
    
    theLogger - the logger to add.
  - setPort
```
public void setPort(int port)
```
    Set the serial port to listen on. Setting this will alter the entire characteristics of this wrapper, in particular it will reset the port manager and all references to the existing port manager will be lost.
    
    Parameters:
    
    port - the port number to use for the SECSI connection
    
    See Also:
    
    SerialPortManager
  - setPortManager
```
public void setPortManager(PortManager pm)
```
    Sets the port manager for the wrapper. May be null if there is no connection.
    
    Specified by:
    
    setPortManager in interface WrapperInterface
    
    Parameters:
    
    the - port manager.
  - setRetryLimit
```
public void setRetryLimit(int newValue)
```
    Sets the retry limit.
    
    Parameters:
    
    newValue - the number of times messages should be retried before being considered a failed message.
  - setT1
```
public void setT1(double newValue)
```
    Sets the T1 timeout value.
    
    Parameters:
    
    newValue - the new T1 value
  - setT2
```
public void setT2(double newValue)
```
    Sets the T2 timeout value.
    
    Parameters:
    
    newValue - the new T2 value
  - setT3
```
public void setT3(double newValue)
```
    Sets the T3 timeout value.
    
    Specified by:
    
    setT3 in interface WrapperInterface
    
    Parameters:
    
    newValue - the new T3 value
  - setT4
```
public void setT4(double newValue)
```
    Sets the T4 timeout value.
    
    Parameters:
    
    newValue - the new T4 value
  - start
```
public void start()
           throws BadParameterException,
                  VIBUpdateFailedException
```
    Throws:
    
    BadParameterException
    
    VIBUpdateFailedException
  - stop
```
public void stop()
          throws BadParameterException
```
    Throws:
    
    BadParameterException

Class SecsIWrapper

Field Summary

Fields inherited from interface com.ergotech.secs.WrapperInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.ergotech.secs.WrapperInterface

Field Detail

portManagerFactoryClass

Constructor Detail

SecsIWrapper

Method Detail

addMessageHandler

addMessageHandler

connect

destroy

disconnect

getAllowDuplicateMessages

getBaudRate

getDefaultAllowDuplicateMessages

getDeviceId

getIsHost

getLogger

getMessageHandlers

getPort

getPortManager

getPortManager

getRawSessionManager

getRetryLimit

getSessionManager

getSessionManager

getT1

getT2

getT3

getT4

init

initializeConnection

removeMessageHandler

secsEvent

setAllowDuplicateMessages

setBaudRate

setDefault

setDefaultAllowDuplicateMessages

setDeviceId

setIsHost

setLogger

setPort

setPortManager

setRetryLimit

setT1

setT2

setT3

setT4

start

stop