TemporaryFile Class Reference

The TemporaryFile class is used to represent an actual image file on disk which will be deleted after script execution. Temporary files can be instantiated in the scripting environment or retrieved in an SM_InputPortWrapper object. More...

#include <fileinterface.h>

Inheritance diagram for TemporaryFile:

Collaboration diagram for TemporaryFile:

Public Slots
TemporaryFile &	setExtension (String &ext)
	Change extension from automatically generated file name. Extension won't change if there is an open stream.
Public Slots inherited from SCR_FileWrapper
SCR_FileWrapper &	setPath (String &path)
	Specify absolute path of this image file. Name of file can be changed only if there is an open stream.
String	path ()
	Retrieve file path.
String	extension ()
	Retrieve file extension.
bool	exists ()
	Verify if file exists on disk.
bool	isOpen ()
	Check if file is opened.
bool	isClose ()
	Check if file is closed.
bool	open (int m=int(SCR_FileIOTypeWrapper::WRITE_ONLY))
	Open file stream for read/write.
bool	close ()
	Close file stream.
void	write (String &text)
	Write string in current stream.
void	writeLine (String &text)
	Write string line in current stream.
void	write (SCR_FileWrapper *file)
	Write entire content of parameter file in current stream.
String	read ()
	Read entire content of stream.
String	readLine ()
	Read single line of stream.
bool	move (SCR_FileWrapper *dest)
bool	copy (SCR_FileWrapper *dest)

Public Member Functions
	TemporaryFile ()
	Create a new TemporaryFile.
	TemporaryFile (String extension)
	Create a new TemporaryFile.

Detailed Description

The TemporaryFile class is used to represent an actual image file on disk which will be deleted after script execution. Temporary files can be instantiated in the scripting environment or retrieved in an SM_InputPortWrapper object.

You can use it in both Script Editor and scriptModule.

file = new TemporaryFile( "txt" );

file.open( IO.WRITE_ONLY );                 // open with write only stream
file.writeLine( "Hello World!" );           // write line to file
file.close();                               // close file

Constructor & Destructor Documentation

TemporaryFile::TemporaryFile

(

)

Create a new TemporaryFile.

TemporaryFile::TemporaryFile

(

String

extension

)

Create a new TemporaryFile.

Parameters

extension

Extension of new TemporaryFile

Member Function Documentation

TemporaryFile& TemporaryFile::setExtension ( String &  ext )

slot

Change extension from automatically generated file name. Extension won't change if there is an open stream.

Parameters

ext	Extension String of image file

Returns

TemporaryFile reference

---

The documentation for this class was generated from the following file:

• dox_files/objectScript/fileinterface.h