com.ergotech.transsecs.secs

Class FileRecipeManager

java.lang.Object

com.ergotech.transsecs.secs.FileRecipeManager

All Implemented Interfaces:

RecipeManagerInterface

public class FileRecipeManager
extends java.lang.Object
implements RecipeManagerInterface

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	defaultBaseDirectory The default file dir, typically "user.dir"
static java.lang.String	defaultFileExtension The default file extension, typically .rcp

Fields inherited from interface com.ergotech.transsecs.secs.RecipeManagerInterface

cvsRev

Constructor Summary

Constructors

Constructor and Description
FileRecipeManager() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseDirectory() Returns the directory of the file.
java.lang.String	getFileExtension() The file extension.
SecsFormat00	getPPIDList() This will return a list of PPIDs as a SecsFormt00.
SecsMsg	getResponse(SecsMsg msg) This method handles S7F3 (Process Program Send), S7F5 (Process Program Request), S7F17 (Process Program Delete), and S7F19 (Current EPPD Request).
boolean	processMessage(SecsMsg msg) This method handles S7F3 (Process Program Send), S7F5 (Process Program Request), S7F17 (Process Program Delete), and S7F19 (Current EPPD Request).
void	setBaseDirectory(java.lang.String baseDirectory) Sets the base directory.
void	setFileExtension(java.lang.String fileExtension) The file extension.

Methods inherited from class java.lang.Object

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

Field Detail

defaultBaseDirectory

public static java.lang.String defaultBaseDirectory

The default file dir, typically "user.dir"

defaultFileExtension

public static java.lang.String defaultFileExtension

The default file extension, typically .rcp

Constructor Detail

FileRecipeManager

public FileRecipeManager()

Default constructor.

Method Detail

getBaseDirectory

public java.lang.String getBaseDirectory()

Returns the directory of the file.

getFileExtension

public java.lang.String getFileExtension()

The file extension. This will be added to any file written and used in, for example, directory listings.

getPPIDList

public SecsFormat00 getPPIDList()

This will return a list of PPIDs as a SecsFormt00.

getResponse

public SecsMsg getResponse(SecsMsg msg)

This method handles S7F3 (Process Program Send), S7F5 (Process Program Request), S7F17 (Process Program Delete), and S7F19 (Current EPPD Request). If the incoming message is not one of these messages then null is returned otherwise a secs message suitable for a response is returned.

processMessage

public boolean processMessage(SecsMsg msg)

This method handles S7F3 (Process Program Send), S7F5 (Process Program Request), S7F17 (Process Program Delete), and S7F19 (Current EPPD Request).

Specified by:

processMessage in interface RecipeManagerInterface

setBaseDirectory

public void setBaseDirectory(java.lang.String baseDirectory)

Sets the base directory. The file will be created in this directory. The directory can be relative or absolute. If relative, the directory will be relative to the location the application is started from. This may be different from the base of the application, that is, the system property "user.dir" is not prepended here.

setFileExtension

public void setFileExtension(java.lang.String fileExtension)

The file extension. This will be added to any file written and used in, for example, directory listings.