com.ergotech.transsecs.secs

Class FileRead

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.transsecs.secs.FileRead

public class FileRead
extends SimpleManipulator

Use Case: It is desired to map a recipe to a file. That is, the S7F3 method and the S7F6 method should work with a disk-based file. The PPID of these messages is the file name, the PPBODY is either written (S7F3) or read (S7F6) from the disk file. Implementation: This component is most useful in the OPC Server version of TransSECS. It should be used with a StringPropertyTarget so that the parameters can be set from OPC tags. The tagnames of the StringPropertyTargets become the OPC item names and setting a value to any of those item names will cause the corresponding property to be set in this object.

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 The Revision String.

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
FileRead() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseDirectory() Returns the directory of the file.
java.lang.String	getFileName() Returns the name of the file.
void	setBaseDirectory(java.lang.String baseDirectory) Sets the base directory.
void	setFileName(java.lang.String fileName) Sets the name of the file.
void	valueInput(ValueChangedEvent theEvent) This method is called by beans and other data sources to set the value of this server.

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, toString, valueChanged

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, setTimebase, setTrace, setValueObject, start, stop, 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

cvsRev

public static final java.lang.String cvsRev

The Revision String.

See Also:

Constant Field Values

Constructor Detail

FileRead

public FileRead()

Default constructor.

Method Detail

getBaseDirectory

public java.lang.String getBaseDirectory()

Returns the directory of the file.

getFileName

public java.lang.String getFileName()

Returns the name of the file.

setBaseDirectory

public void setBaseDirectory(java.lang.String baseDirectory)
                      throws VIBUpdateFailedException

Sets the base directory. The file will be created in this directory.

Throws:

VIBUpdateFailedException - thrown is "setFileName" throws.

setFileName

public void setFileName(java.lang.String fileName)
                 throws VIBUpdateFailedException

Sets the name of the file. This will also read the file and update all the server pushes.

Throws:

VIBUpdateFailedException - thrown if the name of the recipe cannot be sent to the listeners.

valueInput

public void valueInput(ValueChangedEvent theEvent)
                throws VIBUpdateFailedException

This method is called by beans and other data sources to set the value of this server.

Overrides:

valueInput in class Manipulator

Parameters:

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

Throws:

VIBUpdateFailedException