com.ergotech.vib.ports

Class PortDeviceServer

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

All Implemented Interfaces:

SimulationListener

Direct Known Subclasses:

PLCDeviceServer, SerialPortDevice

public abstract class PortDeviceServer
extends DeviceManagerManipulator
implements SimulationListener

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 int	CANNOT_OPEN_PORT Port cannot be opened.
int	currentErrorCount The current error count.
int	debugLevel The specific debug level for this device server.
static java.lang.String	DEFAULT_NAME An arbitrary assigned name.
static int	globalDebugLevel The debug level for all PLCs.
static boolean	globalSimulation This variable will be true if we are simulating PLC read/writes.
static int	MISSING_PARAMETER Some parameter is not yet set.
static int	NO_ERROR No Error.
static int	NO_PORT Port does not exist.
static int	NO_RESOURCES Out of resources.
static int	PORT_ERROR Some error with the open port.
static int	READ_ERROR Some error reading the PLC.
static java.lang.String	TOO_MANY_ERRORS_STRING The string that is displayed when too many errors have been detected.
static int	UNKNOWN_ERROR Some unidentified error.
static int	WRITE_ERROR Some error writing the PLC.

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

cvsRev

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
PortDeviceServer() The default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canConnect() This is designed for subclasses to modify to determine if they have all the information to connect to the server.
void	clearMessageLog() This will send an empty string as the message string and send a value of zero (NO_ERROR) to the output.
void	configurePort() Perform any configuration required on the port.
void	destroy() Indicate by means of a property change event that the device server is no more.
boolean	equals(java.lang.Object test) Returns true if the object passed equals this object.
double	getLinkTimeout() Returns the link timeout in seconds.
int	getLinkTimeoutMilliseconds() Returns the link timeout in milliseconds.
int	getResponseTimeout() Returns the response timeout for this connection .
abstract boolean	hasServers() Returns true if this device has servers associated with it.
void	incrementErrorCount() This routine increments the error count.
void	init() Initialize the Ports.
void	initializePortPool() Creates the factory for this object.
boolean	isSimulating()
boolean	isSimulationFlag()
void	messageLog(java.lang.String msg, int errorNumber) Logs informational/debug messages.
void	printException(java.lang.Throwable t) Print the exceptions.
void	releasePortPool() Frees all port/factory related resources for this component.
void	resetErrorCount() This routine resets the current error count.
void	setLinkTimeout(double linkTimeout) Sets the link timeout in seconds.
void	setName(java.lang.String name) The name of the device.
void	setResponseTimeout(int responseTimeout) Sets the response timeout for this connection.
void	setSimulationFlag(boolean simulationFlag) Force the listener to understand this method.
void	setTimebase(double newValue) Sets the timebase.
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.

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

availableServers, 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

CANNOT_OPEN_PORT

public static final int CANNOT_OPEN_PORT

Port cannot be opened.

See Also:

Constant Field Values

currentErrorCount

public int currentErrorCount

The current error count.

debugLevel

public int debugLevel

The specific debug level for this device server. This is set by the system property devicename.debuglevel (eg -Dmyplc.debuglevel). If this system property is not set the global debug level will be used.

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

An arbitrary assigned name.

See Also:

Constant Field Values

globalDebugLevel

public static int globalDebugLevel

The debug level for all PLCs. This is set by plc.debuglevel define (eg -Dplc.debuglevel=100). If the specific debug level for this component is not set then this will be the debug level.

globalSimulation

public static boolean globalSimulation

This variable will be true if we are simulating PLC read/writes. This defaults to simulating.

MISSING_PARAMETER

public static final int MISSING_PARAMETER

Some parameter is not yet set.

See Also:

Constant Field Values

NO_ERROR

public static final int NO_ERROR

No Error.

See Also:

Constant Field Values

NO_PORT

public static final int NO_PORT

Port does not exist.

See Also:

Constant Field Values

NO_RESOURCES

public static final int NO_RESOURCES

Out of resources. For example, no more sockets in a shared socket system.

See Also:

Constant Field Values

PORT_ERROR

public static final int PORT_ERROR

Some error with the open port.

See Also:

Constant Field Values

READ_ERROR

public static final int READ_ERROR

Some error reading the PLC.

See Also:

Constant Field Values

TOO_MANY_ERRORS_STRING

public static java.lang.String TOO_MANY_ERRORS_STRING

The string that is displayed when too many errors have been detected.

UNKNOWN_ERROR

public static final int UNKNOWN_ERROR

Some unidentified error.

See Also:

Constant Field Values

WRITE_ERROR

public static final int WRITE_ERROR

Some error writing the PLC.

See Also:

Constant Field Values

Constructor Detail

PortDeviceServer

public PortDeviceServer()

The default constructor.

Method Detail

canConnect

public boolean canConnect()

This is designed for subclasses to modify to determine if they have all the information to connect to the server. Mainly used with TCP setHostName when applethost is set.

clearMessageLog

public void clearMessageLog()

This will send an empty string as the message string and send a value of zero (NO_ERROR) to the output.

configurePort

public void configurePort()

Perform any configuration required on the port. This could include opening the port, setting parameters, etc. etc. This method is not called until the port is about to be used, that is, it is not called until a server that uses this port has a listener added to it. The default implementation does nothing. This method should be resistant to multiple calls.

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 DeviceManagerManipulator

Throws:

BadParameterException

See Also:

DataSource.destroy()

equals

public boolean equals(java.lang.Object test)

Returns true if the object passed equals this object. In this case, equals, means that the "toString"s are the same.

Overrides:

equals in class java.lang.Object

getLinkTimeout

public double getLinkTimeout()

Returns the link timeout in seconds. This variable is stored internally in milliseconds and the conversion is performed within this method.

Returns:

the linkTimeout

getLinkTimeoutMilliseconds

public int getLinkTimeoutMilliseconds()

Returns the link timeout in milliseconds.

Returns:

the linkTimeout

getResponseTimeout

public int getResponseTimeout()

Returns the response timeout for this connection . The value is in milliseconds.

hasServers

public abstract boolean hasServers()

Returns true if this device has servers associated with it. This is used to determine if some warning messages should be logged. That is, some messages will only be logged if there are servers. This avoids problems with messages being logged during initialization.

incrementErrorCount

public void incrementErrorCount()

This routine increments the error count. It will limit the printing for retry attempts of the port.

init

public void init()
          throws BadParameterException

Initialize the Ports. The device server should be configured at all times, and not just while "running" for pure applets, the applet that has the device server may not be running, but the device server can be used in a different applet.

Overrides:

init in class DeviceManagerManipulator

Throws:

BadParameterException

See Also:

DataSource.init()

initializePortPool

public void initializePortPool()

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 -

isSimulating

public boolean isSimulating()

Returns:

Returns the simulation.

isSimulationFlag

public boolean isSimulationFlag()

Returns:

Returns the simulation.

messageLog

public void messageLog(java.lang.String msg,
                       int errorNumber)

Logs informational/debug messages. This will also be captured as the output for the device.

printException

public void printException(java.lang.Throwable t)

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

releasePortPool

public void releasePortPool()

Frees all port/factory related resources for this component.

Parameters:

factoryName -

resetErrorCount

public void resetErrorCount()

This routine resets the current error count.

setLinkTimeout

public void setLinkTimeout(double linkTimeout)

Sets the link timeout in seconds. This variable is stored internally in milliseconds and the conversion is performed within this method.

Parameters:

linkTimeout - the linkTimeout to set

setName

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

The name of the device. This is an aribtrary string provided by the user. This method will also reset currentErrorCount.

Overrides:

setName in class DeviceManagerManipulator

Throws:

BadParameterException

See Also:

#getTagName

setResponseTimeout

public void setResponseTimeout(int responseTimeout)

Sets the response timeout for this connection. The value is in milliseconds.

setSimulationFlag

public void setSimulationFlag(boolean simulationFlag)

Description copied from interface: SimulationListener

Force the listener to understand this method. This method will be generated in the source code for any SimulationListener with a value of "false". This forces all systems to be live when deployed (unless the global simulation -D option is set.) This simulation flag may, or may not be controlled by the simulationChangedEvent above. For example, in the PLCs the simulationChangedEvent causes the global simulation flag to be set or reset, whereas the setSimulationFlag causes a local simulation flag to change. Again in the case of PLCs both flags must be false for the system to connect to the real device.

Specified by:

setSimulationFlag in interface SimulationListener

Parameters:

simulation - The simulation to set.

setTimebase

public void setTimebase(double newValue)

Sets the timebase. This is used as the default for children of this device server. This method is overridden to avoid the side effects of the super class's method. That is, this does not cause the server to unsuspend, start reading values, or anything similar.

Overrides:

setTimebase in class SimpleDataSource

Parameters:

newValue - the timebase of the server

See Also:

SimpleDataSource.getTimebase()

simulationStateChanged

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

Sets/resets the global simulation flag.

Specified by:

simulationStateChanged in interface SimulationListener

Throws:

java.lang.Exception - TODO

See Also:

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 DeviceManagerManipulator

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 DeviceManagerManipulator

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 Manipulator

Returns:

the assigned name of this device

See Also:

setName(java.lang.String)