PermanentFile Class Reference

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

#include <fileinterface.h>

Inheritance diagram for PermanentFile:

Collaboration diagram for PermanentFile:

Public Slots
PermanentFile &	remove ()
	Remove physical file manually. Cannot remove file 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
	PermanentFile ()
	Create a new SCR_FileWrapper.
	PermanentFile (String path)
	Create a new PermanentFile.

Detailed Description

The PermanentFile class is used to represent an actual image file on disk which will not be deleted after script execution. Permanent 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 PermanentFile( "C:\file.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

PermanentFile::PermanentFile

(

)

Create a new SCR_FileWrapper.

PermanentFile::PermanentFile

(

String

path

)

Create a new PermanentFile.

Parameters

path	Path to physic PermanentFile

Member Function Documentation

PermanentFile& PermanentFile::remove ( )

slot

Remove physical file manually. Cannot remove file if there is an open stream.

Returns

PermanentFile reference

---

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

• dox_files/objectScript/fileinterface.h