ScriptModule
|
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 InputPort object. More...
#include <FileInterface.h>
Public Slots | |
PermanentFile & | remove () |
Remove physical file manually. Cannot remove file if there is an open stream. | |
Public Slots inherited from File | |
File & | setPath (const String &path) |
Specify absolute path of this image file. Name of file can be changed only if there is an open stream. | |
String | path () const |
Retrieve file path. | |
String | extension () const |
Retrieve file extension. | |
bool | exists () const |
Verify if file exists on disk. | |
bool | isOpen () const |
Check if file is opened. | |
bool | isClose () const |
Check if file is closed. | |
bool | open (int m=int(IO::WRITE_ONLY)) |
Open file stream for read/write. | |
bool | close () |
Close file stream. | |
void | write (const String &text) |
Write string in current stream. | |
void | writeLine (const String &text) |
Write string line in current stream. | |
void | write (File 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 (File dest) |
bool | copy (File dest) |
Public Member Functions | |
PermanentFile () | |
Create a new File. | |
PermanentFile (String path) | |
Create a new PermanentFile. | |
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 InputPort object.
You can use it in both Script Editor and scriptModule.
PermanentFile::PermanentFile | ( | ) |
Create a new File.
PermanentFile::PermanentFile | ( | String | path | ) |
Create a new PermanentFile.
path | Path to physic PermanentFile |
|
slot |
Remove physical file manually. Cannot remove file if there is an open stream.