LocalEquipmentConfig (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.servers.DataSource
- - com.ergotech.vib.servers.SimpleDataSource
  - - com.ergotech.vib.manipulators.Manipulator
    - - com.ergotech.transsecs.secs.LocalEquipmentConfig

All Implemented Interfaces:

PriorityStart

Direct Known Subclasses:

LocalHostConfig
```
public abstract class LocalEquipmentConfig
extends Manipulator
implements PriorityStart
```
This object can be placed on an MIStudio screen and used to configure a SECS connection. The methods are pass-throughs to the TransSECS controller of the same name.

Nested Class Summary
- Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource
  SimpleDataSource.NameEditorData
- Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource
  DataSource.Writable

Field Summary
- Fields inherited from class com.ergotech.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.util.PriorityStart
  cvsRev

Constructor Summary

Constructors
Constructor and Description

LocalEquipmentConfig()
The default constructor.

LocalEquipmentConfig(PersistenceInterface persistenceInterface)

Constructors
Constructor and Description
`LocalEquipmentConfig()` The default constructor.
`LocalEquipmentConfig(PersistenceInterface persistenceInterface)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Calls through to the TransSecsController method.
`int`	`getBaudRate()` Returns the Baud Rate.
`int`	`getDeviceId()` Returns the device id.
`java.util.Map<java.lang.String,java.util.List<java.util.List<ConnectorTransientRepresentation>>>`	`getDevicesConnectors()` Used when reloading in MIStudio.
`java.util.List<java.util.List<ConnectorTransientRepresentation>>`	`getGEMConnectors()` Used when reloading in MIStudio.
`java.util.Enumeration<java.lang.String>`	`getInPortNames()` For OPC we don't want to generate the "active" tags if this is a tool project.
`double`	`getPassiveT1()` Returns the T1 for the passive connection.
`double`	`getPassiveT2()` Returns T2 for the passive connection.
`double`	`getPassiveT3()` Returns T3 for the passive connection.
`double`	`getPassiveT4()` Returns T4 for the passive connection.
`int`	`getPassiveT5()` Returns T5 for the passive connection.
`int`	`getPassiveT6()` Returns T6 for the passive connection.
`int`	`getPassiveT7()` Returns T7 for the passive connection.
`int`	`getPassiveT8()` Returns T8 for the passive connection.
`java.lang.String`	`getPersistenceFileName()` Returns the filename to used for persistence.
`PersistenceInterface`	`getPersistenceInterface()` Return the persistance config.
`int`	`getPort()` Returns the passive port.
`TransSecsController`	`getTransSecsController()`
`void`	`init()` Calls through to the TransSecsController method.
`void`	`save()` Persist a property.
`void`	`setBaudRate(int baudRate)` Set the Baud Rate of a SECSI connection.
`void`	`setDeviceId(int deviceId)` Sets the device Id.
`void`	`setDevicesConnectors(java.util.Map<java.lang.String,java.util.List<java.util.List<ConnectorTransientRepresentation>>> connectors)` Reform all the devices connections.
`void`	`setGEMConnectors(java.util.List<java.util.List<ConnectorTransientRepresentation>> connectors)` Reform all the GEM connections.
`void`	`setPassiveT1(double newValue)` Sets T1 for a passive link.
`void`	`setPassiveT2(double newValue)` Sets T2 for a passive link.
`void`	`setPassiveT3(double newValue)` Sets T3 for a passive link.
`void`	`setPassiveT4(double newValue)` Sets T4 for a passive link.
`void`	`setPassiveT5(int newValue)` Sets T5 for a passive link.
`void`	`setPassiveT6(int newValue)` Sets T6 for a passive link.
`void`	`setPassiveT7(int newValue)` Sets T7 for a passive link.
`void`	`setPassiveT8(int newValue)` Sets T8 for a passive link.
`void`	`setPersistenceFileName(java.lang.String persistenceFileName)` Sets the filename to used for persistence.
`void`	`setPersistenceInterface(PersistenceInterface persistenceInterface)` Set the persistance config.
`void`	`setPort(int port)` Sets the passive port.
`void`	`start()` Calls through to the TransSecsController method.
`void`	`stop()` Calls through to the TransSecsController method.

Methods inherited from class com.ergotech.vib.manipulators.Manipulator
getDefaultQualityForLocation, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged, valueInput

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource
addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LocalEquipmentConfig
```
public LocalEquipmentConfig()
```
    The default constructor.
  - LocalEquipmentConfig
```
public LocalEquipmentConfig(PersistenceInterface persistenceInterface)
```
- Method Detail
  - destroy
```
public void destroy()
             throws BadParameterException
```
    Calls through to the TransSecsController method.
    
    Overrides:
    
    destroy in class SimpleDataSource
    
    Throws:
    
    BadParameterException
    
    See Also:
    
    SimpleDataSource.destroy()
  - getBaudRate
```
public int getBaudRate()
```
    Returns the Baud Rate. This is only used by SECSI connections.
    
    See Also:
    
    TransSecsController.getBaudRate()
  - getDeviceId
```
public int getDeviceId()
```
    Returns the device id.
    
    See Also:
    
    TransSecsController.getDeviceId()
  - getDevicesConnectors
```
public java.util.Map<java.lang.String,java.util.List<java.util.List<ConnectorTransientRepresentation>>> getDevicesConnectors()
```
    Used when reloading in MIStudio. This will produce a list of connector that are connected to the elements of the devices node. This list is consumed by the "setDevicesConnectors" method which will reform the connection.
    
    Returns:
    
    A Map containing a list of connectors. The map may be empty (no devices) but will not be null.
  - getGEMConnectors
```
public java.util.List<java.util.List<ConnectorTransientRepresentation>> getGEMConnectors()
```
    Used when reloading in MIStudio. This will produce a list of connector that are connected to the VIDs, ALIDs, CEIDs and messages. This list is consumed by the "setGEMConnectors" method which will reform the connection.
    
    Returns:
    
    A list of connectors.
  - getInPortNames
```
public java.util.Enumeration<java.lang.String> getInPortNames()
```
    For OPC we don't want to generate the "active" tags if this is a tool project.
    
    Overrides:
    
    getInPortNames in class Manipulator
    
    See Also:
    
    Manipulator.addInPortName(String), Manipulator.getInPortNames()
  - getPassiveT1
```
public double getPassiveT1()
```
    Returns the T1 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT1()
  - getPassiveT2
```
public double getPassiveT2()
```
    Returns T2 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT2()
  - getPassiveT3
```
public double getPassiveT3()
```
    Returns T3 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT3()
  - getPassiveT4
```
public double getPassiveT4()
```
    Returns T4 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT4()
  - getPassiveT5
```
public int getPassiveT5()
```
    Returns T5 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT5()
  - getPassiveT6
```
public int getPassiveT6()
```
    Returns T6 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT6()
  - getPassiveT7
```
public int getPassiveT7()
```
    Returns T7 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT7()
  - getPassiveT8
```
public int getPassiveT8()
```
    Returns T8 for the passive connection.
    
    See Also:
    
    TransSecsController.getPassiveT8()
  - getPersistenceFileName
```
public java.lang.String getPersistenceFileName()
```
    Returns the filename to used for persistence.
    
    Returns:
    
    the filename to used for persistence.
    
    See Also:
    
    TransSecsController.getPassiveT7()
  - getPersistenceInterface
```
public PersistenceInterface getPersistenceInterface()
```
    Return the persistance config. There's a fairly loose connection between the persistance file and this configuration. The persistance file gets/sets values directly to the transsecs controller and does not use the setters/getters in this configuration. (This configuration also passes through to the TransSECS controller so the values are the same).
    
    Returns:
    
    the persistenceInterface
  - getPort
```
public int getPort()
```
    Returns the passive port.
    
    See Also:
    
    TransSecsController.getPort()
  - getTransSecsController
```
public TransSecsController getTransSecsController()
```
    Returns:
    
    Returns the TransSecsController.
  - init
```
public void init()
          throws BadParameterException
```
    Calls through to the TransSecsController method.
    
    Overrides:
    
    init in class DataSource
    
    Throws:
    
    BadParameterException
    
    See Also:
    
    DataSource.init()
  - save
```
public void save()
```
    Persist a property.
  - setBaudRate
```
public void setBaudRate(int baudRate)
```
    Set the Baud Rate of a SECSI connection.
    
    See Also:
    
    TransSecsController.setBaudRate(int)
  - setDeviceId
```
public void setDeviceId(int deviceId)
```
    Sets the device Id.
    
    See Also:
    
    TransSecsController.setDeviceId(int)
  - setDevicesConnectors
```
public void setDevicesConnectors(java.util.Map<java.lang.String,java.util.List<java.util.List<ConnectorTransientRepresentation>>> connectors)
```
    Reform all the devices connections.
    
    Parameters:
    
    connectors - the connectors
  - setGEMConnectors
```
public void setGEMConnectors(java.util.List<java.util.List<ConnectorTransientRepresentation>> connectors)
```
    Reform all the GEM connections.
    
    Parameters:
    
    connectors - the connectors
  - setPassiveT1
```
public void setPassiveT1(double newValue)
```
    Sets T1 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT1(double)
  - setPassiveT2
```
public void setPassiveT2(double newValue)
```
    Sets T2 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT2(double)
  - setPassiveT3
```
public void setPassiveT3(double newValue)
```
    Sets T3 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT3(double)
  - setPassiveT4
```
public void setPassiveT4(double newValue)
```
    Sets T4 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT4(double)
  - setPassiveT5
```
public void setPassiveT5(int newValue)
```
    Sets T5 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT5(int)
  - setPassiveT6
```
public void setPassiveT6(int newValue)
```
    Sets T6 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT6(int)
  - setPassiveT7
```
public void setPassiveT7(int newValue)
```
    Sets T7 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT7(int)
  - setPassiveT8
```
public void setPassiveT8(int newValue)
```
    Sets T8 for a passive link.
    
    See Also:
    
    TransSecsController.setPassiveT8(int)
  - setPersistenceFileName
```
public void setPersistenceFileName(java.lang.String persistenceFileName)
```
    Sets the filename to used for persistence. If non-null and not empty, this file will store the state of ALIDs, CEIDs, etc for the GEM Model.
    
    Parameters:
    
    persistenceFileName -
    
    See Also:
    
    TransSecsController.setPersistenceFileName(String)
  - setPersistenceInterface
```
public void setPersistenceInterface(PersistenceInterface persistenceInterface)
```
    Set the persistance config. There's a fairly loose connection between the persistance file and this configuration. The persistance file gets/sets values directly to the transsecs controller and does not use the setters/getters in this configuration. (This configuration also passes through to the TransSECS controller so the values are the same). The creation of the persistanceInterface instance will have grabbed the value from the controller, created, restored, saved, etc. the file. This call needs to nothing. It is stored so that changes made through this configuration can be stored.
    
    Parameters:
    
    persistenceInterface - the persistenceInterface to set
  - setPort
```
public void setPort(int port)
```
    Sets the passive port.
    
    See Also:
    
    TransSecsController.setPort(int)
  - start
```
public void start()
           throws BadParameterException,
                  VIBUpdateFailedException
```
    Calls through to the TransSecsController method.
    
    Overrides:
    
    start in class SimpleDataSource
    
    Throws:
    
    BadParameterException
    
    VIBUpdateFailedException
    
    See Also:
    
    SimpleDataSource.start()
  - stop
```
public void stop()
          throws BadParameterException
```
    Calls through to the TransSecsController method.
    
    Overrides:
    
    stop in class SimpleDataSource
    
    Throws:
    
    BadParameterException
    
    See Also:
    
    SimpleDataSource.stop()

Class LocalEquipmentConfig

Nested Class Summary

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

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

Field Summary

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

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

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

Fields inherited from interface com.ergotech.util.PriorityStart

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

LocalEquipmentConfig

LocalEquipmentConfig

Method Detail

destroy

getBaudRate

getDeviceId

getDevicesConnectors

getGEMConnectors

getInPortNames

getPassiveT1

getPassiveT2

getPassiveT3

getPassiveT4

getPassiveT5

getPassiveT6

getPassiveT7

getPassiveT8

getPersistenceFileName

getPersistenceInterface

getPort

getTransSecsController

init

save

setBaudRate

setDeviceId

setDevicesConnectors

setGEMConnectors

setPassiveT1

setPassiveT2

setPassiveT3

setPassiveT4

setPassiveT5

setPassiveT6

setPassiveT7

setPassiveT8

setPersistenceFileName

setPersistenceInterface

setPort

start

stop