com.ergotech.vib.servers.ppi

Class PPIServer

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.ppi.PPIServer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

S7

public abstract class PPIServer
extends PLCServer

This is the abstract superclass of the PPI protocol. These classes implement layer 7 of the Siemens PPI 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
int	headerOffset The header offset in and SD2 message (7).
static int	PDU_HEADER_OFFSET The header offset in a PDU response message.
static byte	PROTO_ID The protocol ID.
static byte	RED_ID The redundancy ID.
static byte	ROSCTR_ACK The Remote Operating Services Control (ROSCTR) - Acknowledge Request.
static byte	ROSCTR_ACKNOWLEDGEMENT_EMPTY The Remote Operating Services Control (ROSCTR) - Acknowledgement without the parameter and data fields.
static byte	ROSCTR_ACKNOWLEDGEMENT_EXTRA The Remote Operating Services Control (ROSCTR) - Acknowledgement with extended header information in the parameter fields.
static byte	ROSCTR_ACKNOWLEDGEMENT_FULL The Remote Operating Services Control (ROSCTR) - Acknowledgement with either or both the parameter and data fields.

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
PPIServer() 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.
static java.lang.String	getErrorString(int errorCode) Maps error codes to error strings.
int	getHeaderOffset()
byte	getMemoryAreaCode() Returns the memory area code.
int	getPDURef() The synchronized accessor for the PDF REF.
java.lang.String	getReg() Returns the register address in the PLC.
boolean	isConfigured() Returns true if the configuration of this server is complete.
void	setAddress(java.lang.String address) Sets the PLC address.
void	setByteOffset(int offset) Sets the offset of the register of this server.
void	setHeaderOffset(int headerOffset)
void	setReg(java.lang.String address) Sets the register address in the PLC.
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, setLength, setOptimizeReads, setOutputBytes, setSigned, setStationAddress, setSwapStyle, setTimebase, setTriggerOnThread, setValueFrom, setValueObject, 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

headerOffset

public int headerOffset

The header offset in and SD2 message (7).

PDU_HEADER_OFFSET

public static int PDU_HEADER_OFFSET

The header offset in a PDU response message. The total offset will then be the SD2 message header offset plus this value (12).

PROTO_ID

public static byte PROTO_ID

The protocol ID. PROTO_ID is always 0x32 for PPI.

RED_ID

public static byte RED_ID

The redundancy ID. RED_ID is currently always 0x0.

ROSCTR_ACK

public static byte ROSCTR_ACK

The Remote Operating Services Control (ROSCTR) - Acknowledge Request. ROSCTR_ACK is 0x1.

ROSCTR_ACKNOWLEDGEMENT_EMPTY

public static byte ROSCTR_ACKNOWLEDGEMENT_EMPTY

The Remote Operating Services Control (ROSCTR) - Acknowledgement without the parameter and data fields. ROSCTR_ACKNOWLEDGEMENT_EMPTY is 0x2.

ROSCTR_ACKNOWLEDGEMENT_EXTRA

public static byte ROSCTR_ACKNOWLEDGEMENT_EXTRA

The Remote Operating Services Control (ROSCTR) - Acknowledgement with extended header information in the parameter fields. ROSCTR_ACKNOWLEDGEMENT_EXTRA is 0x7.

ROSCTR_ACKNOWLEDGEMENT_FULL

public static byte ROSCTR_ACKNOWLEDGEMENT_FULL

The Remote Operating Services Control (ROSCTR) - Acknowledgement with either or both the parameter and data fields. ROSCTR_ACKNOWLEDGEMENT_FULL is 0x3.

Constructor Detail

PPIServer

public PPIServer()

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.

getErrorString

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

Maps error codes to error strings.

Parameters:

the - error code

Returns:

the error String

getHeaderOffset

public int getHeaderOffset()

Returns:

Returns the headerOffset.

getMemoryAreaCode

public byte getMemoryAreaCode()

Returns the memory area code. This is defined by the PPI spec. for the different address types.

getPDURef

public int getPDURef()

The synchronized accessor for the PDF REF.

getReg

public java.lang.String getReg()

Returns the register address in the PLC. This is here for consistency and is just a passthrough to "setAddresss"

Returns:

the register number of the server.

See Also:

getAddress()

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.

Parameters:

address - The new value.

Throws:

PLCException

setByteOffset

public void setByteOffset(int offset)

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

setHeaderOffset

public void setHeaderOffset(int headerOffset)

Parameters:

headerOffset - The headerOffset to set.

setReg

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

Sets the register address in the PLC. This is here for consistency and is just a passthrough to "setAddresss"

Parameters:

address - The register address value

Throws:

PLCException

See Also:

setAddress(java.lang.String)

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