com.ergotech.vib.servers.plc

Class PLCArray

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.PLCArray

Direct Known Subclasses:

ModbusArray, S7Array

public abstract class PLCArray
extends SimpleManipulator

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	ELEMENT_SEPARATOR

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

Constructor Summary

Constructors

Constructor and Description
PLCArray() Create the Servers.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeviceName() Gets the id of the server.
java.lang.String	getReg() Returns the starting register.
int	getRegisterCount() Returns the register count.
java.lang.String	getStartReg() Returns the starting register (an integer, or -1 if it has not been set).
int	getStaticLocationFor(java.lang.String loc) This is used by the StaticMethodEvent to determine which valueChanged method to call.
int	getStationAddress() Returns the station address.
boolean	isTriggerOnThread() Returns whether or not to trigger on thread.
void	setDeviceName(java.lang.String deviceName) Sets the name of the device server
void	setReg(java.lang.String reg) Set the starting register for this array.
void	setRegisterCount(int registerCount) Set the number of registers to use.
void	setStartReg(java.lang.String startReg) Set the starting register for this array.
void	setStationAddress(int stationAddress) Sets the station address for the target.
void	setTimebase(double timebase) Override this since we do not have a timebase, but need to pass it to our servers.
void	setTriggerOnThread(boolean triggerOnThread) Set whether or not to trigger each register on a thread.
void	start() Starts this server and all the servers we created.
void	stop() Stops this server and all the servers we created.
void	triggerValueChanged(ValueChangedEvent event) This allows a server without a timebase to be triggered for a read
void	valueChanged(int loc, ValueChangedEvent e) This calls the proper valueChanged method based on the return from the getStaticLocationFor method.
void	valueInput(ValueChangedEvent newEvent) This method assumes that it receives an array value object.

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

getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString

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

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, 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, 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, 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

ELEMENT_SEPARATOR

public static final java.lang.String ELEMENT_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

PLCArray

public PLCArray()

Create the Servers.

Method Detail

getDeviceName

public java.lang.String getDeviceName()

Gets the id of the server. This could be the hostname or some other string Returns the device number

getReg

public java.lang.String getReg()

Returns the starting register.

getRegisterCount

public int getRegisterCount()

Returns the register count.

getStartReg

public java.lang.String getStartReg()

Returns the starting register (an integer, or -1 if it has not been set).

Returns:

the starting register

getStaticLocationFor

public int getStaticLocationFor(java.lang.String loc)
                         throws BadParameterException

This is used by the StaticMethodEvent to determine which valueChanged method to call. An integer index is returned which is used by the valueChanged (int,ValueChangedEvent) method.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException - thrown if the location is unknown

getStationAddress

public int getStationAddress()

Returns the station address.

isTriggerOnThread

public boolean isTriggerOnThread()

Returns whether or not to trigger on thread.

Returns:

Returns the triggerOnThread.

setDeviceName

public void setDeviceName(java.lang.String deviceName)

Sets the name of the device server

Parameters:

deviceName - the name of the device

setReg

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

Set the starting register for this array. This will only accept the format that is normally used for this PLC

Throws:

PLCException

setRegisterCount

public void setRegisterCount(int registerCount)

Set the number of registers to use.

setStartReg

public void setStartReg(java.lang.String startReg)
                 throws PLCException

Set the starting register for this array.

Throws:

PLCException

setStationAddress

public void setStationAddress(int stationAddress)

Sets the station address for the target.

setTimebase

public void setTimebase(double timebase)

Override this since we do not have a timebase, but need to pass it to our servers.

Overrides:

setTimebase in class SimpleDataSource

Parameters:

timebase - the timebase of the server

See Also:

SimpleDataSource.getTimebase()

setTriggerOnThread

public void setTriggerOnThread(boolean triggerOnThread)

Set whether or not to trigger each register on a thread.

Parameters:

triggerOnThread - The triggerOnThread to set.

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Starts this server and all the servers we created.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

SimpleDataSource.start()

stop

public void stop()
          throws BadParameterException

Stops this server and all the servers we created.

Overrides:

stop in class SimpleDataSource

Throws:

BadParameterException

See Also:

SimpleDataSource.stop()

triggerValueChanged

public void triggerValueChanged(ValueChangedEvent event)
                         throws VIBUpdateFailedException

This allows a server without a timebase to be triggered for a read

Throws:

VIBUpdateFailedException

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This calls the proper valueChanged method based on the return from the getStaticLocationFor method.

Overrides:

valueChanged in class Manipulator

Throws:

VIBUpdateFailedException

BadParameterException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This method assumes that it receives an array value object. The values of the array will be written to the server in order. They will be written until either array has no more elements. That is, we will not assume that the size of the incoming array must match the size of the array of PLC servers.

Overrides:

valueInput in class Manipulator

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException