com.ergotech.vib.servers.modbus

Class ModbusTCPDeviceServer

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

com.ergotech.vib.servers.modbus.ModbusTCPDeviceServerBase

com.ergotech.vib.servers.modbus.ModbusTCPDeviceServer

All Implemented Interfaces:

SimulationListener

public class ModbusTCPDeviceServer
extends ModbusTCPDeviceServerBase

This component extends the ModbusTCPDeviceServerBase to add an Active TCP port to the object. This component must be placed in a design and can be configured either with the properties, or dynamically (connections). There are two basic properties added, the IP address (or hostname) and the port number. Whenever these are valid, an attempt is made to create a port for the device server.

Nested Class Summary

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

ModbusDeviceServerBase.TimingMetrics

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 java.lang.String	PORT_FACTORY_NAME The name of the port factory.

Fields inherited from class com.ergotech.vib.servers.modbus.ModbusDeviceServerBase

metricPrintFrequency, modbusDeviceServers

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

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
ModbusTCPDeviceServer() This sets the factory name.

Method Summary

Modifier and Type	Method and Description
void	_initializePortPool() If the port and host are set, this creates the factory for this object.
java.lang.String	getHostname() Returns the hostname/ip address of the PLC.
int	getMaximumSocketConnections()
int	getPortNumber() Returns the PLC port number.
int	getStaticLocationFor(java.lang.String method) Returns 3 for hostname and 4 for portnumber.
void	initializePortPool() Overridden to set the maximum number of connections.
void	setHostname(java.lang.String hostname) Sets the hostname/ip address of the PLC.
void	setMaximumSocketConnections(int maximumSocketConnection)
void	setPortNumber(int portNumber) Sets the port number of the PLC.
void	start() initialize the port pool once the container has been set.
void	valueChanged(int loc, ValueChangedEvent e) This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object.
void	VIBEvent(VIBEvent vibEvent) Resets "applethost".

Methods inherited from class com.ergotech.vib.servers.modbus.ModbusTCPDeviceServerBase

getUseTransactionIds, setUseTransactionIds, toString

Methods inherited from class com.ergotech.vib.servers.modbus.ModbusDeviceServerBase

availableServers, deviceType, forceLoad, getModbusDeviceServers, isBlockReads, readDevice, setBlockReads, setName, setTimebase, stop, writeDevice

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

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

canConnect, clearMessageLog, configurePort, equals, getLinkTimeout, getLinkTimeoutMilliseconds, getResponseTimeout, incrementErrorCount, init, 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, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, 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

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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

PORT_FACTORY_NAME

public static final java.lang.String PORT_FACTORY_NAME

The name of the port factory. This is "TCPActivePortFactory".

See Also:

Constant Field Values

Constructor Detail

ModbusTCPDeviceServer

public ModbusTCPDeviceServer()

This sets the factory name.

Method Detail

_initializePortPool

public void _initializePortPool()

If the port and host are set, this creates the factory for this object. This will do nothing if the factory name has not been set, or the port name is not set.

Overrides:

_initializePortPool in class ModbusDeviceServerBase

Parameters:

factoryName -

getHostname

public java.lang.String getHostname()

Returns the hostname/ip address of the PLC.

Returns:

Returns the hostname.

getMaximumSocketConnections

public int getMaximumSocketConnections()

Returns:

Returns the maximumSocketConnection.

getPortNumber

public int getPortNumber()

Returns the PLC port number. This is almost always 502.

Returns:

Returns the portNumber.

getStaticLocationFor

public int getStaticLocationFor(java.lang.String method)
                         throws BadParameterException

Returns 3 for hostname and 4 for portnumber.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

initializePortPool

public void initializePortPool()

Overridden to set the maximum number of connections.

Overrides:

initializePortPool in class PortDeviceServer

See Also:

PortDeviceServer.initializePortPool()

setHostname

public void setHostname(java.lang.String hostname)

Sets the hostname/ip address of the PLC.

Parameters:

hostname - The hostname to set.

setMaximumSocketConnections

public void setMaximumSocketConnections(int maximumSocketConnection)

Parameters:

maximumSocketConnection - The maximumSocketConnection to set.

setPortNumber

public void setPortNumber(int portNumber)

Sets the port number of the PLC. This should normally be left as 502.

Parameters:

portNumber - The portNumber to set.

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

initialize the port pool once the container has been set.

Overrides:

start in class ModbusTCPDeviceServerBase

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

PLCDeviceServer.start()

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object. This will call valuechanged every time.

Overrides:

valueChanged in class Manipulator

Throws:

VIBUpdateFailedException

BadParameterException

VIBEvent

public void VIBEvent(VIBEvent vibEvent)
              throws BadParameterException

Resets "applethost".

Overrides:

VIBEvent in class SimpleDataSource

Throws:

BadParameterException

See Also:

com.ergotech.vib.servers.SimpleDataSource#VIBEvent(com.ergotech.vib.utils.VIBEvent)