com.ergotech.vib.servers.ab

Class ControlLogixServer

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.ab.ControlLogixServer

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

Direct Known Subclasses:

ControlLogixArrayServer, ControlLogixBooleanServer, ControlLogixIntServer, ControlLogixRealServer, ControlLogixStringServer

public class ControlLogixServer
extends PLCServer

This is the abstract superclass of the Logix Ethernet protocol. This uses the structure from DF1. The device server uses the PCCC-style messaging. 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 java.lang.String	cvsRev

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

BINARY_VALUE, BOOLEAN_VALUE, BOTHSWAP, BYTESWAP, 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
ControlLogixServer() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddressInternal() Returns the PLC internal address.
int	getByteOffset() Returns the offset of the register of this server.
java.lang.String	getLogixTagName() Returns the PLC address.
int	getValueType() Returns the value type for this server.
java.lang.String	getVariableName() Get the variable name
boolean	isSimilar(PLCServer server) For BOOL array elements that have indices ( [x] ) the address is only similar if the array name is the same.
void	setLogixTagName(java.lang.String address) Sets the PLC address.
void	setValueFrom(byte[] image, int offset, int quality) Update the value of the server from an address block THIS should never be called on this class.
void	setValueFrom(ControlLogixResponseDataBlock msgIn, int index) Set the value from the array of values created in the device server.
void	setValueType(int valueType) Set the value type for this server.
void	setVariableName(java.lang.String variableName) Set the variable name.
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, isConfigured, isDirty, isTriggerOnThread, outByteSwap, propertyChange, setAddressType, setBCD, setBit, setBitCount, setDeviceName, setDirty, setLength, setOptimizeReads, setOutputBytes, setSigned, setStationAddress, setSwapStyle, setTimebase, setTriggerOnThread, 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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

ControlLogixServer

public ControlLogixServer()

Default constructor.

Method Detail

getAddressInternal

public java.lang.String getAddressInternal()

Returns the PLC internal address. This is always trimmed. For bit addresses, this will be missing the .x

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.

getLogixTagName

public java.lang.String getLogixTagName()

Returns the PLC address.

Returns:

the PLC address.

getValueType

public int getValueType()

Returns the value type for this server.

Returns:

one of the enumerated value types

getVariableName

public java.lang.String getVariableName()

Get the variable name

Returns:

the variable name

isSimilar

public boolean isSimilar(PLCServer server)

For BOOL array elements that have indices ( [x] ) the address is only similar if the array name is the same.

Overrides:

isSimilar in class PLCServer

See Also:

getAddressInternal()

setLogixTagName

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

Sets the PLC address. This is just a tag name in the ControlLogix controller. We'll accept anything other than an empty string. If the address is .x where x >=0 && x <=15 then we'll assume a bit address and read the base tag and strip the bit value after the value is read.

Parameters:

address - The new value.

Throws:

PLCException

setValueFrom

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

Update the value of the server from an address block THIS should never be called on this class.

Specified by:

setValueFrom in class PLCServer

Throws:

java.lang.ArrayIndexOutOfBoundsException

setValueFrom

public void setValueFrom(ControlLogixResponseDataBlock msgIn,
                         int index)

Set the value from the array of values created in the device server.

Parameters:

msgIn - the incoming values

index - our index into the values.

setValueType

public void setValueType(int valueType)

Set the value type for this server. This should be one of the enumerations in ControlLogixEthernetDeviceServer. This is really only relevant for writing (but helps with reading unsigned values).

Parameters:

valueType - the value type for this server

setVariableName

public void setVariableName(java.lang.String variableName)
                     throws PLCException

Set the variable name.

Parameters:

variableName - the name of the variable

Throws:

PLCException - thrown if the variable name is invalid

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