com.ergotech.vib.servers.fins

Class FinsServer

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.plc.PLCServer

com.ergotech.vib.servers.fins.FinsServer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

FinsDInt, FinsFloat, FinsString

public class FinsServer
extends PLCServer

This is the abstract superclass of the FINS protocol. These classes implement layer 7 of the Siemens FINS protocol. This class provides support that is common to all classes, such as building the message from the header, parameter block and the data block.

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	maxBlockSize The maximum allowable block size for an address block.

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

BINARY_VALUE, BOOLEAN_VALUE, BOTHSWAP, BYTESWAP, cvsRev, DOUBLE_WORD_VALUE, FLOAT_VALUE, NOSWAP, STRING_VALUE, WORD_VALUE, WORDSWAP

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

Constructor Summary

Constructors

Constructor and Description
FinsServer() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress() Returns the PLC address.
int	getByteOffset() Returns the offset of the register of this server.
boolean	getByteSwapString() Returns whether strings are byte-swapped.
static java.lang.String	getErrorString(int errorCode) Maps error codes to error strings.
int	getMemoryAddress()
int	getMemoryAreaCode()
int	getValueType() Returns the value type for this server.
boolean	isConfigured() Returns true if the configuration of this server is complete.
void	setAddress(java.lang.String address) Sets the PLC address.
void	setByteSwapString(boolean byteSwapString) Sets whether strings are byte-swapped.
void	setLength(int length) sets the number of bytes that need to be read to satisfy this server.
void	setValueFrom(byte[] image, int offset, int quality) Update the value of the server from an address block
void	setValueObject(ValueObjectInterface newValue) This is here to allow outside development systems to change the value of the broadcast server.
void	setValueType(int valueType) Set the value type for this server.
java.lang.String	toString() returns a string representation of this server.
PLCDataBlock	validateResponse(PLCDataBlock msgOut, PLCDataBlock msgIn) Returns true if the response to a message is correct.

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

configure, destroy, fromBCD, fromBCD, getAddressType, getBit, getBitCount, getDefaultQualityForLocation, getDeviceName, getDeviceServer, getDirty, getLength, getOptimizeReads, getOutputBytes, getPLCAddressBlock, getSigned, getStaticLocationFor, getStationAddress, getSwapStyle, inByteSwap, isBCD, isDirty, isSimilar, isTriggerOnThread, outByteSwap, propertyChange, setAddressType, setBCD, setBit, setBitCount, setDeviceName, setDirty, setOptimizeReads, setOutputBytes, setSigned, setStationAddress, setSwapStyle, setTimebase, setTriggerOnThread, shouldBeAdded, start, stop, toBCD, toBCD, triggerRead, triggerValueChanged, valueChanged, VIBEvent

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, clientRequest, 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, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTrace, 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, init, 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

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

Field Detail

maxBlockSize

public static int maxBlockSize

The maximum allowable block size for an address block.

Constructor Detail

FinsServer

public FinsServer()

Default constructor.

Method Detail

getAddress

public java.lang.String getAddress()

Returns the PLC address.

Returns:

the PLC address.

getByteOffset

public int getByteOffset()

Returns the offset of the register of this server. The value is always returned in 8-bit bytes regardless of the length of the word.

Specified by:

getByteOffset in class PLCServer

Returns:

the register offset of the server.

getByteSwapString

public boolean getByteSwapString()

Returns whether strings are byte-swapped.

getErrorString

public static java.lang.String getErrorString(int errorCode)

Maps error codes to error strings.

Parameters:

the - error code

Returns:

the error String

getMemoryAddress

public int getMemoryAddress()

Returns:

the memoryAddress

getMemoryAreaCode

public int getMemoryAreaCode()

Returns:

the memoryAreaCode

getValueType

public int getValueType()

Returns the value type for this server.

Returns:

one of the enumerated value types

isConfigured

public boolean isConfigured()

Description copied from class: PLCServer

Returns true if the configuration of this server is complete. This is called before attempting to add the server to an Address Block or a device.

Overrides:

isConfigured in class PLCServer

Returns:

true if the server is fully configured, otherwise false.

setAddress

public void setAddress(java.lang.String address)
                throws PLCException

Sets the PLC address. The address is parsed according to the following logic: The first byte must be one of A, C, D, E, H, I, R, W.

The second byte is optional for a C, D and . It is mandatory for I and not permissible for A, D, E, H, W. E's have some special handling associated with the expansion data memory. E's may have the format Exxxxx, Exxxxx.bb, Exx:yyyyy, Exx:yyy.bb

The string is case insensitive, it will be uppercased.

Parameters:

address - The new value.

Throws:

PLCException

setByteSwapString

public void setByteSwapString(boolean byteSwapString)

Sets whether strings are byte-swapped.

setLength

public void setLength(int length)

sets the number of bytes that need to be read to satisfy this server.

Overrides:

setLength in class PLCServer

setValueFrom

public void setValueFrom(byte[] image,
                         int offset,
                         int quality)
                  throws java.lang.ArrayIndexOutOfBoundsException

Update the value of the server from an address block

Specified by:

setValueFrom in class PLCServer

Throws:

java.lang.ArrayIndexOutOfBoundsException

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

This is here to allow outside development systems to change the value of the broadcast server. This method should be added on a server-by- server-basis. Implementing this value is sufficient to implement a write server. All other methods, setFloatValue, setIntValue, etc. will be forwarded to this method.

Overrides:

setValueObject in class PLCServer

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

PLCServer.setValueObject(com.ergotech.vib.valueobjects.ValueObjectInterface)

setValueType

public void setValueType(int valueType)

Set the value type for this server. This should be one of the enumerations above.

Parameters:

valueType - the value type for this server

toString

public java.lang.String toString()

returns a string representation of this server.

Overrides:

toString in class PLCServer

Returns:

a string description of this server

validateResponse

public PLCDataBlock validateResponse(PLCDataBlock msgOut,
                                     PLCDataBlock msgIn)
                              throws PLCException

Returns true if the response to a message is correct.

Specified by:

validateResponse in class PLCServer

Throws:

PLCException