com.ergotech.vib.servers.plc

Class PLCDeviceServer

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.vib.servers.DeviceManagerManipulator

com.ergotech.vib.ports.PortDeviceServer

com.ergotech.vib.servers.plc.PLCDeviceServer

Direct Known Subclasses:

ControlLogixEthernetDeviceServer, ControlLogixEthernetDirectDeviceServer, CP243SlaveDeviceServer, DF1DeviceServer, FinsDeviceServer, HostLinkDeviceServer, LogixEthernetDeviceServer, MelsecDeviceServer, ModbusDeviceServerBase, PPIDeviceServerBase, RFC1006DeviceServer

public abstract class PLCDeviceServer
extends PortDeviceServer

The PLC Device Server provides the actual communication to the PLC device. Subclasses of this object can support different protocols for communicating to the device, including PLC/TCP, PLC Serial (RTU), and through TCP-Serial Converters.

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

Modifier and Type	Field and Description
static java.lang.String	cvsRev
static boolean	sharedPLCSimulation Set to true to use a mapped file to share simulated PLC data.

Fields inherited from class com.ergotech.vib.ports.PortDeviceServer

CANNOT_OPEN_PORT, currentErrorCount, debugLevel, DEFAULT_NAME, globalDebugLevel, globalSimulation, MISSING_PARAMETER, NO_ERROR, NO_PORT, NO_RESOURCES, PORT_ERROR, READ_ERROR, TOO_MANY_ERRORS_STRING, UNKNOWN_ERROR, WRITE_ERROR

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, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
PLCDeviceServer() The default constructor.

Method Summary

Modifier and Type	Method and Description
void	addServer(PLCServer plcServer) Find, or create a block to which to add the PLC server.
void	aggregateBlocks(java.lang.String type) Looks and see if any of the blocks are touching.
void	destroy() Indicate by means of a property change event that the device server is no more.
java.util.Vector<? super PLCAddressBlock>	getBlocksForType(java.lang.String type) Find the appropriate blocks.
int	getMaximumBlockOffset() Returns the message offset.
byte[]	getRegisterBlock(java.lang.String blockType, int startAddress, int size) This method returns a register block (byte[]) that is the correct type and at least large enough to read or write the simulated registers.
byte[]	getRegisterBlockLocal(java.lang.String blockType, int startAddress, int size) This method returns a register block (byte[]) that is the correct type and at least large enough to read or write the simulated registers.
byte[]	getRegisterBlockShared(java.lang.String blockType, int startAddress, int size) This method returns a register block (byte[]) that is the correct type and at least large enough to read or write the simulated registers.
boolean	hasServers() Returns true if there are any servers associated with this device.
void	printException(java.lang.Throwable t) Print the exceptions.
void	readAllLongTimebaseServers() Read all the values for this device that have timebase of < 2 seconds.
abstract PLCDataBlock	readDevice(PLCDataBlock msgOut) A PLC transaction.
void	removeServer(PLCServer plcServer) Removes a PLCServer, typically a bean or other data source, from this object.
void	setMaximumBlockOffset(int maximumBlockOffset) Sets the message offset.
void	simulatedWrite(java.lang.String blockType, int startAddress, PLCDataBlock values) This method is used to simulate a write to the device.
PLCDataBlock	simulateRead(java.lang.String blockType, int startAddress, int size) This method is used to provide data for a simulated read of the device.
void	simulationStateChanged(SimulationChangedEvent simulationChangedEvent) Sets/resets the global simulation flag.
void	start() This method controls communication to the device.
void	stop() This method is the opposite of "start" after calling this method, until the start method is called again, there will be no communication with the device.
java.lang.String	toString() Returns the assigned name of this device.
abstract PLCDataBlock	writeDevice(PLCDataBlock msgOut) Writes the packet to the PLC.

Methods inherited from class com.ergotech.vib.ports.PortDeviceServer

canConnect, clearMessageLog, configurePort, equals, getLinkTimeout, getLinkTimeoutMilliseconds, getResponseTimeout, incrementErrorCount, init, initializePortPool, isSimulating, isSimulationFlag, messageLog, releasePortPool, resetErrorCount, setLinkTimeout, setName, setResponseTimeout, setSimulationFlag, setTimebase

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

availableServers, clientRequest, createServer, deleteDevice, deleteServer, getEditableServers, getPersistentServers, getServerContainer, getServers, getServersInternal, getViewServers, preparingServer, setContainer, setServers

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

getDefaultQualityForLocation

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

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, valueChanged, valueInput

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

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientResponse, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setCustomTimer, setDataSourceName, setExportCriteria, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, 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, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

sharedPLCSimulation

public static boolean sharedPLCSimulation

Set to true to use a mapped file to share simulated PLC data.

Constructor Detail

PLCDeviceServer

public PLCDeviceServer()

The default constructor.

Method Detail

addServer

public void addServer(PLCServer plcServer)

Find, or create a block to which to add the PLC server.

aggregateBlocks

public void aggregateBlocks(java.lang.String type)

Looks and see if any of the blocks are touching. If so, combine them.

destroy

public void destroy()
             throws BadParameterException

Indicate by means of a property change event that the device server is no more.

Overrides:

destroy in class PortDeviceServer

Throws:

BadParameterException

See Also:

DataSource.destroy()

getBlocksForType

public java.util.Vector<? super PLCAddressBlock> getBlocksForType(java.lang.String type)

Find the appropriate blocks. This method is exposed for unit testing only.

getMaximumBlockOffset

public int getMaximumBlockOffset()

Returns the message offset. This is how close an address must be to a block before it can be added, or how close two blocks must be before they will be aggregated.

getRegisterBlock

public byte[] getRegisterBlock(java.lang.String blockType,
                               int startAddress,
                               int size)
                        throws PLCException

This method returns a register block (byte[]) that is the correct type and at least large enough to read or write the simulated registers.

Throws:

PLCException

getRegisterBlockLocal

public byte[] getRegisterBlockLocal(java.lang.String blockType,
                                    int startAddress,
                                    int size)
                             throws PLCException

This method returns a register block (byte[]) that is the correct type and at least large enough to read or write the simulated registers. This block is only available locally (within this JVM).

Throws:

PLCException

getRegisterBlockShared

public byte[] getRegisterBlockShared(java.lang.String blockType,
                                     int startAddress,
                                     int size)
                              throws PLCException

This method returns a register block (byte[]) that is the correct type and at least large enough to read or write the simulated registers. This block uses a MappedByteBuffer so that it is available to other processes.

Throws:

PLCException

hasServers

public boolean hasServers()

Returns true if there are any servers associated with this device. In this case this means allBlocksByType.size() != 0

Specified by:

hasServers in class PortDeviceServer

printException

public void printException(java.lang.Throwable t)

Print the exceptions. This will limit the speed at which exceptions are generated and printed.

Overrides:

printException in class PortDeviceServer

readAllLongTimebaseServers

public void readAllLongTimebaseServers()
                                throws BadParameterException

Read all the values for this device that have timebase of < 2 seconds. This will occur, for example, when the servers change from simulation mode.

Throws:

BadParameterException

readDevice

public abstract PLCDataBlock readDevice(PLCDataBlock msgOut)
                                 throws PLCException

A PLC transaction. Send out the message, get the reply and return it.

Parameters:

msgOut - the message to send

Throws:

PLCException

removeServer

public void removeServer(PLCServer plcServer)

Removes a PLCServer, typically a bean or other data source, from this object. If this was the last listener, we will call stop ourselves.

Parameters:

plcServer - the server to be removed.

See Also:

addServer(com.ergotech.vib.servers.plc.PLCServer)

setMaximumBlockOffset

public void setMaximumBlockOffset(int maximumBlockOffset)

Sets the message offset. This is how close an address must be to a block before it can be added, or how close two blocks must be before they will be aggregated.

Parameters:

maximumBlockOffset - the maximumBlockOffset in bytes.

simulatedWrite

public void simulatedWrite(java.lang.String blockType,
                           int startAddress,
                           PLCDataBlock values)
                    throws PLCException

This method is used to simulate a write to the device.

Throws:

PLCException

simulateRead

public PLCDataBlock simulateRead(java.lang.String blockType,
                                 int startAddress,
                                 int size)
                          throws PLCException

This method is used to provide data for a simulated read of the device. It will return zero unless values have been written to the simulator, in which case, these value will be returned.

Throws:

PLCException

simulationStateChanged

public void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)
                            throws java.lang.Exception

Description copied from class: PortDeviceServer

Sets/resets the global simulation flag.

Overrides:

simulationStateChanged in class PortDeviceServer

Throws:

java.lang.Exception

See Also:

com.ergotech.util.SimulationListener#simulationStateChanged(com.ergotech.util.SimulationChangedEvent)

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

This method controls communication to the device. Until this method is called, there will be no communication to the device (port is closed).

Overrides:

start in class PortDeviceServer

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

com.ergotech.vib.utils.LifeCycle#start()

stop

public void stop()
          throws BadParameterException

This method is the opposite of "start" after calling this method, until the start method is called again, there will be no communication with the device.

Overrides:

stop in class PortDeviceServer

Throws:

BadParameterException

See Also:

com.ergotech.vib.utils.LifeCycle#stop()

toString

public java.lang.String toString()

Returns the assigned name of this device.

Overrides:

toString in class PortDeviceServer

Returns:

the assigned name of this device

See Also:

PortDeviceServer.setName(java.lang.String)

writeDevice

public abstract PLCDataBlock writeDevice(PLCDataBlock msgOut)
                                  throws PLCException

Writes the packet to the PLC.

Throws:

PLCException