com.ergotech.vib.servers.fins

Class FinsDeviceServer

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.fins.FinsDeviceServer

All Implemented Interfaces:

SimulationListener

public class FinsDeviceServer
extends PLCDeviceServer

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.util.Vector<FinsDeviceServer>	finsDeviceServers We maintain a list of all instances of FINSDeviceServers which can be readily accessed when creating a list for the editor.
static int	sid The SID.

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
FinsDeviceServer() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	_initializePortPool() If the port and host are set, this creates the factory for this object.
PLCDataBlock	_readDevice(PLCDataBlock msgOut) Read from the device.
java.util.LinkedHashMap<java.lang.String,java.lang.String>	availableServers() The list of possible sub-servers of this device.
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.
int	getDestinationNetworkAddress()
int	getDestinationNodeNumber()
int	getDestinationUnitNumber()
static java.util.Vector<FinsDeviceServer>	getFinsDeviceServers()
java.lang.String	getHostname() Returns the hostname/ip address of the PLC.
int	getPortNumber() Returns the PLC port number.
int	getRetryCount()
int	getSourceNetworkAddress()
int	getSourceNodeNumber()
int	getSourcePort()
boolean	isVersion2OrHigher()
PLCDataBlock	readDevice(PLCDataBlock msgOut) Read from the device.
void	setDestinationNetworkAddress(int destinationNetworkAddress)
void	setDestinationNodeNumber(int destinationNodeNumber)
void	setDestinationUnitNumber(int destinationUnitNumber)
void	setHostname(java.lang.String hostname) Sets the hostname/ip address of the PLC.
void	setPortNumber(int portNumber) Sets the port number of the PLC.
void	setRetryCount(int retryCount)
void	setSourceNetworkAddress(int sourceNetworkAddress)
void	setSourceNodeNumber(int sourceNodeNumber)
void	setSourcePort(int sourcePort)
void	setVersion2OrHigher(boolean version2OrHigher)
void	simulatedWrite(java.lang.String blockType, int startAddress, PLCDataBlock values, int bit) This method is used to simulate a write to the device.
void	start() This method controls communication to the device.
void	stop() Overridden to remove the instance from the modbusDeviceServers Vector.
PLCDataBlock	writeDevice(PLCDataBlock msgOut) Write to the device.

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

addServer, aggregateBlocks, destroy, getBlocksForType, getMaximumBlockOffset, getRegisterBlock, getRegisterBlockLocal, getRegisterBlockShared, hasServers, printException, readAllLongTimebaseServers, removeServer, setMaximumBlockOffset, simulatedWrite, simulateRead, simulationStateChanged, 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, setName, setResponseTimeout, setSimulationFlag, setTimebase

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

finsDeviceServers

public static java.util.Vector<FinsDeviceServer> finsDeviceServers

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

sid

public static int sid

The SID. This must be between 00 and FF.

Constructor Detail

FinsDeviceServer

public FinsDeviceServer()

Default constructor.

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.

Parameters:

factoryName -

_readDevice

public PLCDataBlock _readDevice(PLCDataBlock msgOut)
                         throws PLCException

Read from the device. This will package the msg into a FINS packet. The msgIn and msgOut The response is returned in the msgIn.

Parameters:

msgOut - the msg to send

Returns:

the response msg

Throws:

PLCException

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.

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(FinsDeviceServer.forceLoad("testName"));

getDestinationNetworkAddress

public int getDestinationNetworkAddress()

Returns:

the destinationNetworkAddress

getDestinationNodeNumber

public int getDestinationNodeNumber()

Returns:

the destinationNodeNumber

getDestinationUnitNumber

public int getDestinationUnitNumber()

Returns:

the destinationUnitNumber

getFinsDeviceServers

public static java.util.Vector<FinsDeviceServer> getFinsDeviceServers()

Returns:

Returns the modbusTCPDeviceServers.

getHostname

public java.lang.String getHostname()

Returns the hostname/ip address of the PLC.

Returns:

Returns the hostname.

getPortNumber

public int getPortNumber()

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

Returns:

Returns the portNumber.

getRetryCount

public int getRetryCount()

Returns:

Returns the retryCount.

getSourceNetworkAddress

public int getSourceNetworkAddress()

Returns:

the sourceNetworkAddress

getSourceNodeNumber

public int getSourceNodeNumber()

Returns:

the sourceNodeNumber

getSourcePort

public int getSourcePort()

Returns:

the sourcePort

isVersion2OrHigher

public boolean isVersion2OrHigher()

Returns:

the version2OrHigher

readDevice

public PLCDataBlock readDevice(PLCDataBlock msgOut)
                        throws PLCException

Read from the device. This will package the msg into a FINS packet. The msgIn and msgOut The response is returned in the msgIn.

Specified by:

readDevice in class PLCDeviceServer

Parameters:

msgOut - the msg to send

Returns:

the response msg

Throws:

PLCException

setDestinationNetworkAddress

public void setDestinationNetworkAddress(int destinationNetworkAddress)

Parameters:

destinationNetworkAddress - the destinationNetworkAddress to set

setDestinationNodeNumber

public void setDestinationNodeNumber(int destinationNodeNumber)

Parameters:

destinationNodeNumber - the destinationNodeNumber to set

setDestinationUnitNumber

public void setDestinationUnitNumber(int destinationUnitNumber)

Parameters:

destinationUnitNumber - the destinationUnitNumber to set

setHostname

public void setHostname(java.lang.String hostname)

Sets the hostname/ip address of the PLC.

Parameters:

hostname - The hostname 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.

setRetryCount

public void setRetryCount(int retryCount)

Parameters:

retryCount - The retryCount to set.

setSourceNetworkAddress

public void setSourceNetworkAddress(int sourceNetworkAddress)

Parameters:

sourceNetworkAddress - the sourceNetworkAddress to set

setSourceNodeNumber

public void setSourceNodeNumber(int sourceNodeNumber)

Parameters:

sourceNodeNumber - the sourceNodeNumber to set

setSourcePort

public void setSourcePort(int sourcePort)

Parameters:

sourcePort - the sourcePort to set

setVersion2OrHigher

public void setVersion2OrHigher(boolean version2OrHigher)

Parameters:

version2OrHigher - the version2OrHigher to set

simulatedWrite

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

This method is used to simulate a write to the device. Superclass does not handle bits correctly - we'll do that here.

Overrides:

simulatedWrite in class PLCDeviceServer

Throws:

PLCException

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Description copied from class: PLCDeviceServer

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 PLCDeviceServer

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

PLCDeviceServer.start()

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

Write to the device. The response is returned in the msgIn.

Specified by:

writeDevice in class PLCDeviceServer

Parameters:

msgOut - the PDU to send

msgIn - the response PDU

Returns:

the length of the response message

Throws:

PLCException