com.ergotech.vib.servers.modbus

Class ModbusDeviceServerBase

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

com.ergotech.vib.servers.modbus.ModbusDeviceServerBase

All Implemented Interfaces:

SimulationListener

Direct Known Subclasses:

ModbusRTUDeviceServerBase, ModbusTCPDeviceServerBase

public abstract class ModbusDeviceServerBase
extends PLCDeviceServer

This is the base for the ModbusTCPDeviceServer. The class must be extended to include a port to create a concrete implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModbusDeviceServerBase.TimingMetrics Store the messages that take the longest, and shortest to get a response.

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 int	metricPrintFrequency If > 0 timing metrics will be printed for the device server.
static java.util.Vector	modbusDeviceServers We maintain a list of all instances of ModbusDeviceServers which can be readily accessed when creating a list for the editor.

Fields inherited from class com.ergotech.vib.servers.plc.PLCDeviceServer

cvsRev, sharedPLCSimulation

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

Constructor Summary

Constructors

Constructor and Description
ModbusDeviceServerBase()

Method Summary

Modifier and Type	Method and Description
void	_initializePortPool() This is used by the subclasses to set the port names before calling "initializePortPool" here it just calls initializePortPool directly.
java.util.LinkedHashMap<java.lang.String,java.lang.String>	availableServers() The list of possible sub-servers of this device.
java.lang.String	deviceType() The type of the address block.
static java.lang.String	forceLoad(java.lang.String value) This is generated by the property editor to force a reference to the DeviceServer for genjar.
static java.util.Vector<? extends ModbusDeviceServerBase>	getModbusDeviceServers()
boolean	isBlockReads() Returns true if we are blocking reads.
PLCDataBlock	readDevice(PLCDataBlock msgOut) Read the packet from the PLC.
void	setBlockReads(boolean flag) Set to true to prevent the blocking of reads.
void	setName(java.lang.String name) If the name is changed we need to update the list of device servers.
void	setTimebase(double newValue) Sets the timebase.
void	stop() Overridden to remove the instance from the modbusDeviceServers Vector.
PLCDataBlock	writeDevice(PLCDataBlock msgOut) Writes the packet to the PLC.

Methods inherited from class com.ergotech.vib.servers.plc.PLCDeviceServer

addServer, aggregateBlocks, destroy, getBlocksForType, getMaximumBlockOffset, getRegisterBlock, getRegisterBlockLocal, getRegisterBlockShared, hasServers, printException, readAllLongTimebaseServers, removeServer, setMaximumBlockOffset, simulatedWrite, simulatedWrite, simulateRead, simulationStateChanged, start, toString

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, setResponseTimeout, setSimulationFlag

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

clientRequest, createServer, deleteDevice, deleteServer, earlyStart, 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, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, 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, 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

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

Field Detail

metricPrintFrequency

public static int metricPrintFrequency

If > 0 timing metrics will be printed for the device server. The value is the frequency of printing, eg 500 will print the metics every 500 messages.

modbusDeviceServers

public static java.util.Vector modbusDeviceServers

We maintain a list of all instances of ModbusDeviceServers which can be readily accessed when creating a list for the editor.

Constructor Detail

ModbusDeviceServerBase

public ModbusDeviceServerBase()

Method Detail

_initializePortPool

public void _initializePortPool()

This is used by the subclasses to set the port names before calling "initializePortPool" here it just calls initializePortPool directly.

availableServers

public java.util.LinkedHashMap<java.lang.String,java.lang.String> availableServers()

The list of possible sub-servers of this device.

Overrides:

availableServers in class DeviceManagerManipulator

Returns:

a hash of server name vs server class for the demo servers.

deviceType

public java.lang.String deviceType()

The type of the address block. Returns the object name, port and hostname.

forceLoad

public static java.lang.String forceLoad(java.lang.String value)

This is generated by the property editor to force a reference to the DeviceServer for genjar. should look similar to this setDeviceName(ModbusRTUDeviceServer.forceLoad("testName"));

getModbusDeviceServers

public static java.util.Vector<? extends ModbusDeviceServerBase> getModbusDeviceServers()

Returns:

Returns the modbusTCPDeviceServers.

isBlockReads

public boolean isBlockReads()

Returns true if we are blocking reads.

readDevice

public PLCDataBlock readDevice(PLCDataBlock msgOut)
                        throws PLCException

Read the packet from the PLC.

Specified by:

readDevice in class PLCDeviceServer

Parameters:

msgOut - the message to send

Throws:

PLCException

setBlockReads

public void setBlockReads(boolean flag)

Set to true to prevent the blocking of reads. Each register will be read as an individual register.

Parameters:

flag - set to true to cause blocking of reads.

setName

public void setName(java.lang.String name)
             throws BadParameterException

If the name is changed we need to update the list of device servers.

Overrides:

setName in class PortDeviceServer

Throws:

BadParameterException

See Also:

SimpleDataSource.setName(java.lang.String)

setTimebase

public void setTimebase(double newValue)

Sets the timebase. This will update the timebase on all the servers that were created that have the same timebase as this component.

Overrides:

setTimebase in class PortDeviceServer

Parameters:

newValue - the timebase of the server

See Also:

SimpleDataSource.getTimebase()

stop

public void stop()
          throws BadParameterException

Overridden to remove the instance from the modbusDeviceServers Vector.

Overrides:

stop in class PLCDeviceServer

Throws:

BadParameterException

See Also:

DataSource.stop()

writeDevice

public PLCDataBlock writeDevice(PLCDataBlock msgOut)
                         throws PLCException

Writes the packet to the PLC.

Specified by:

writeDevice in class PLCDeviceServer

Throws:

PLCException