TransSecsVoyeur (ErgoTech VIB/TransSECS Scripting API)

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

Direct Known Subclasses:

TransSecsGEMController
```
public class TransSecsVoyeur
extends TransSecsController
```
This is the TransSECS Voyeur. It provides an active connection to equipment with an optional Voyeur link that will act as a pass through to a host. If the port is set for voyeur (ie a passive link is completely configured) then a pass through link will be created and we will be a true Voyeur.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class TransSecsVoyeur.ConnectionEventListener
The SecsEvent Listener.
- Nested classes/interfaces inherited from class com.ergotech.transsecs.secs.TransSecsController
  TransSecsController.ResponseWrapper

Nested Classes
Modifier and Type	Class and Description
`class`	`TransSecsVoyeur.ConnectionEventListener` The SecsEvent Listener.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Object`	`activeDefaultMessageHandler` The default message handler to use to the equipment.
`int`	`beanDebugLevel` this bean's debug level (an expert property)
`static int`	`debugLevel` Set this to enable debugging.

Fields inherited from class com.ergotech.transsecs.secs.TransSecsController
ACTIVE_PORT, allInstances, connectionConfig, csvFolder, DEFAULT_TRANSSECS_APPLICATION, defaultMessageHandler, DEVICES_CLIENT_TRANSSECS_APPLICATION, FILE_RECIPE_MANAGER, invertHostOrEquipmentConnection, lastProcessed, PASSIVE_PORT, passThroughGlobal, recipeBaseDir, recipeFileExtension, recipeManager, recipeManagerType, testPanel, transSecsApplicationType

Constructor Summary

Constructors
Constructor and Description

TransSecsVoyeur()

Constructors
Constructor and Description
`TransSecsVoyeur()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`connect(boolean sendingMessage)` Connect the two wrappers and add a pass through message handler to both.
`void`	`destroy()` Destroy the component and destroy all the messages.
`void`	`disconnect()` Disconnects from all wrappers (active if present and passive).
`void`	`disconnectActive()` Disconnect the active wrapper and generally clean up.
`int`	`getActivePort()` Returns the port that this object will use to make an active (host) connection.
`double`	`getActiveT1()`
`double`	`getActiveT2()`
`double`	`getActiveT3()`
`double`	`getActiveT4()`
`int`	`getActiveT5()`
`int`	`getActiveT6()`
`int`	`getActiveT7()`
`int`	`getActiveT8()`
`java.lang.String`	`getActiveToolTarget()` Returns the tool that will be the target.
`int`	`getBeanDebugLevel()` This gets the debug level of this bean.
`java.lang.String`	`getEquipmentHostName()` The host name of the equipment.
`WrapperInterface`	`getWrapper(int whichWrapper)` Returns a wrapper for the give defined constant.
`boolean`	`processMessage(SecsTrigger msg)` Calls the super-classes processMessage and returns true.
`void`	`setActivePort(int newPort)` Sets the port that this object will use to make an active connection.
`void`	`setActiveT1(double newValue)`
`void`	`setActiveT2(double newValue)`
`void`	`setActiveT3(double newValue)`
`void`	`setActiveT4(double newValue)`
`void`	`setActiveT5(int newValue)`
`void`	`setActiveT6(int newValue)`
`void`	`setActiveT7(int newValue)`
`void`	`setActiveT8(int newValue)`
`void`	`setActiveToolTarget(java.lang.String activeToolTarget)` Sets the tool that will be the target.
`void`	`setActiveWrapperClassName(java.lang.String activeWrapperClassName)` Set the active wrapper class name; only useful before connect is called
`void`	`setDebugLevel(int newValue)` This sets the debug level of this bean for system outs.
`void`	`setEquipmentHostName(java.lang.String equipmentHostName)` The host name of the equipment.
`void`	`setLogger(LoggerInterface l)`
`void`	`setPort(int port)` Sets the port that this object will use to listen for active connections.
`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`	`start()` Start the component.
`void`	`stop()` Stop the component.
`java.lang.String`	`toString()` Create a toString to be proud of...

Methods inherited from class com.ergotech.transsecs.secs.TransSecsController
addALID, addALID, addALIDsFromCSV, addCEID, addCEID, addCEIDsFromCSV, addDependentEInterface, addDVID, addECID, addSVID, addVID, addVIDsFromCSV, createDataId, createDevices, createSecsFormat3x5x, disconnectPassive, findController, getActiveConnectionRetryInterval, getAlids, getAllMessages, getAutoResponseMessages, getBaudRate, getCeids, getClassPackage, getConnectionConfig, getControllerName, getDeviceId, getEquipmentWrapper, getGemCompliant, getGemHandler, getLinkTestInterval, getLocalDebug, getLogger, getMatchingPrimary, getMatchingResponse, getMessageBean, getPassiveT1, getPassiveT2, getPassiveT3, getPassiveT4, getPassiveT5, getPassiveT6, getPassiveT7, getPassiveT8, getPassiveToolTarget, getPersistenceFileName, getPort, getSimulationListener, getSingleController, getUnhandledPrimaries, getVids, getWrapperDescription, handleHandCraftedMessage, init, isAllowDuplicateSECSIMessages, isDigitalTwin, isPassThrough, isS1F3ReturnsValues, logInfo, newInstance, println, processMessage, processMessage, publish, publish, publishReport, register, registerEventComponents, registerForReceiveNotification, registerInstance, removeDependentEInterface, sendResponse, setActiveConnectionRetryInterval, setAllowDuplicateSECSIMessages, setBaudRate, setClassPackage, setConnectionConfig, setControllerName, setDeviceId, setDigitalTwin, setFileRecipeManagerExtension, setFileRecipeManagerPath, setGemCompliant, setLinkTestInterval, setLocalDebug, setPassiveT1, setPassiveT2, setPassiveT3, setPassiveT4, setPassiveT5, setPassiveT6, setPassiveT7, setPassiveT8, setPassiveToolTarget, setPassiveWrapperClassName, setPassThrough, setPersistenceFileName, setS1F3ReturnsValues, setSoftRevAndMDLN, setupFileRecipeManager, unregisterInstance, valueInput

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

- Field Detail
  - activeDefaultMessageHandler
```
public static java.lang.Object activeDefaultMessageHandler
```
    The default message handler to use to the equipment. 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.
  - beanDebugLevel
```
public int beanDebugLevel
```
    this bean's debug level (an expert property)
  - debugLevel
```
public static int debugLevel
```
    Set this to enable debugging. Values greater than zero generate some debugging, higher numbers generate more output.
- Constructor Detail
  - TransSecsVoyeur
```
public TransSecsVoyeur()
```
- Method Detail
  - connect
```
public void connect(boolean sendingMessage)
```
    Connect the two wrappers and add a pass through message handler to both.
    
    Overrides:
    
    connect in class TransSecsController
  - destroy
```
public void destroy()
             throws BadParameterException
```
    Description copied from class: TransSecsController
    
    Destroy the component and destroy all the messages.
    
    Overrides:
    
    destroy in class TransSecsController
    
    Throws:
    
    BadParameterException
  - disconnect
```
public void disconnect()
```
    Disconnects from all wrappers (active if present and passive).
    
    Overrides:
    
    disconnect in class TransSecsController
  - disconnectActive
```
public void disconnectActive()
```
    Disconnect the active wrapper and generally clean up.
  - getActivePort
```
public int getActivePort()
```
    Returns the port that this object will use to make an active (host) connection.
  - getActiveT1
```
public double getActiveT1()
```
  - getActiveT2
```
public double getActiveT2()
```
  - getActiveT3
```
public double getActiveT3()
```
  - getActiveT4
```
public double getActiveT4()
```
  - getActiveT5
```
public int getActiveT5()
```
  - getActiveT6
```
public int getActiveT6()
```
  - getActiveT7
```
public int getActiveT7()
```
  - getActiveT8
```
public int getActiveT8()
```
  - getActiveToolTarget
```
public java.lang.String getActiveToolTarget()
```
    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.
  - getBeanDebugLevel
```
public int getBeanDebugLevel()
```
    This gets the debug level of this bean.
    
    Returns:
    
    the bean's debug level
  - getEquipmentHostName
```
public java.lang.String getEquipmentHostName()
```
    The host name of the equipment. This is the hostname/ip to which an active connection will be created.
    
    Returns:
    
    the host name of the tool to which an active connection will be created.
  - getWrapper
```
public WrapperInterface getWrapper(int whichWrapper)
```
    Returns a wrapper for the give defined constant.
    
    Overrides:
    
    getWrapper in class TransSecsController
  - processMessage
```
public boolean processMessage(SecsTrigger msg)
```
    Calls the super-classes processMessage and returns true. Since we are a voyeur, there is no requirement that all messages be handled but we need to trick SECS into believing that they have been. In fact they have since they have all been passed to the host.
    
    Overrides:
    
    processMessage in class TransSecsController
  - setActivePort
```
public void setActivePort(int newPort)
```
    Sets the port that this object will use to make an active connection.
  - setActiveT1
```
public void setActiveT1(double newValue)
```
  - setActiveT2
```
public void setActiveT2(double newValue)
```
  - setActiveT3
```
public void setActiveT3(double newValue)
```
  - setActiveT4
```
public void setActiveT4(double newValue)
```
  - setActiveT5
```
public void setActiveT5(int newValue)
```
  - setActiveT6
```
public void setActiveT6(int newValue)
```
  - setActiveT7
```
public void setActiveT7(int newValue)
```
  - setActiveT8
```
public void setActiveT8(int newValue)
```
  - setActiveToolTarget
```
public void setActiveToolTarget(java.lang.String activeToolTarget)
```
    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.
  - setActiveWrapperClassName
```
public void setActiveWrapperClassName(java.lang.String activeWrapperClassName)
```
    Set the active wrapper class name; only useful before connect is called
  - setDebugLevel
```
public void setDebugLevel(int newValue)
```
    This sets the debug level of this bean for system outs. The messages will be printed to the console for values >0. @ param int debugLevel is a number = 0 for no console logging.
  - setEquipmentHostName
```
public void setEquipmentHostName(java.lang.String equipmentHostName)
```
    The host name of the equipment. This is the hostname/ip to which an active connection will be created.
    
    Parameters:
    
    equipmentHostName - the host name of the tool to which an active connection will be created.
  - setLogger
```
public void setLogger(LoggerInterface l)
```
    Overrides:
    
    setLogger in class TransSecsController
  - setPort
```
public void setPort(int port)
```
    Sets the port that this object will use to listen for active connections.
    
    Overrides:
    
    setPort in class TransSecsController
  - setT1
```
public void setT1(double newValue)
```
    Overrides:
    
    setT1 in class TransSecsController
  - setT2
```
public void setT2(double newValue)
```
    Overrides:
    
    setT2 in class TransSecsController
  - setT3
```
public void setT3(double newValue)
```
    Overrides:
    
    setT3 in class TransSecsController
  - setT4
```
public void setT4(double newValue)
```
    Overrides:
    
    setT4 in class TransSecsController
  - setT5
```
public void setT5(int newValue)
```
    Overrides:
    
    setT5 in class TransSecsController
  - setT6
```
public void setT6(int newValue)
```
    Overrides:
    
    setT6 in class TransSecsController
  - setT7
```
public void setT7(int newValue)
```
    Overrides:
    
    setT7 in class TransSecsController
  - setT8
```
public void setT8(int newValue)
```
    Overrides:
    
    setT8 in class TransSecsController
  - start
```
public void start()
           throws BadParameterException,
                  VIBUpdateFailedException
```
    Description copied from class: TransSecsController
    
    Start the component. Put all the messages in a container and call start on them.
    
    Overrides:
    
    start in class TransSecsController
    
    Throws:
    
    BadParameterException
    
    VIBUpdateFailedException
  - stop
```
public void stop()
          throws BadParameterException
```
    Description copied from class: TransSecsController
    
    Stop the component. Remove all the messages from their container and call stop on them.
    
    Overrides:
    
    stop in class TransSecsController
    
    Throws:
    
    BadParameterException
  - toString
```
public java.lang.String toString()
```
    Create a toString to be proud of...
    
    Overrides:
    
    toString in class TransSecsController

Class TransSecsVoyeur

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

activeDefaultMessageHandler

beanDebugLevel

debugLevel

Constructor Detail

TransSecsVoyeur

Method Detail

connect

destroy

disconnect

disconnectActive

getActivePort

getActiveT1

getActiveT2

getActiveT3

getActiveT4

getActiveT5

getActiveT6

getActiveT7

getActiveT8

getActiveToolTarget

getBeanDebugLevel

getEquipmentHostName

getWrapper

processMessage

setActivePort

setActiveT1

setActiveT2

setActiveT3

setActiveT4

setActiveT5

setActiveT6

setActiveT7

setActiveT8

setActiveToolTarget

setActiveWrapperClassName

setDebugLevel

setEquipmentHostName

setLogger

setPort

setT1

setT2

setT3

setT4

setT5

setT6

setT7

setT8

start

stop

toString