File

File class in Global context

Provides read/write access to the filesystem. Used in the experiment definition to save the experiment state (onExpSave). Other (general purpose) use of this class is rather limited. Files are created in the "scripts_output" subdirectory of the directory where the Framsticks executable is located.

EOF

integer, 0 .. 1 (false/true)

EndOfFile

info

string

information

name

string

name

path

string

full path

pathseparator

string

/ or \

append

returns File

append buffered to the file

function append(string filename, string description)

appendDirect

returns File

append unbuffered to the disk file

function appendDirect(string filename, string description)

returns string

close a file

function close()

returns file contents if it has been buffered

create

returns File

create a new buffered file

function create(string filename, string description)

createDirect

returns File

create a new unbuffered disk file

function createDirect(string filename, string description)

exists

returns integer, 0 .. 1 (false/true)

test if a file exists

function exists()

Sample:
File.exists("default.sim") -> return 0 or 1

flush

doesn't return a value

flush

function flush()

useful for unbuffered disk files only (openDirect, appendDirect)

new

returns File

create a new memory file

function new()

newFromString

returns File

create a new memory file with string contents

function newFromString(string text)

open

returns File

open existing file for reading

function open(string filename)

readLine

returns string

read line

function readLine()

readObject

doesn't return a value

read object

function readObject(object)

readUntilEOF

returns string

read everything

function readUntilEOF()

writeComment

doesn't return a value

write comment string

function writeComment(string anything)

writeNameObject

doesn't return a value

write object with alternate name

function writeNameObject(string name, object)

writeObject

doesn't return a value

write object

function writeObject(object)

writeObjectBegin

doesn't return a value

write object header

function writeObjectBegin(object)

writeObjectEnd

doesn't return a value

finish object

function writeObjectEnd()

writeObjectField

doesn't return a value

write single field

function writeObjectField(object, untyped field_index_or_name)

writeObjectFieldForce

doesn't return a value

write single field

function writeObjectFieldForce(object, untyped field_index_or_name)

writeObjectFields

doesn't return a value

write all fields

function writeObjectFields(object)

writeObjectFieldsForce

doesn't return a value

write all fields

function writeObjectFieldsForce(object)

writeString

doesn't return a value

write anything

function writeString(untyped anything)

EOF integer, 0 .. 1 (false/true)	EndOfFile
info string	information
name string	name
path string	full path
pathseparator string	/ or \
append returns File	append buffered to the file `function append(string filename, string description)`
appendDirect returns File	append unbuffered to the disk file `function appendDirect(string filename, string description)`
close returns string	close a file `function close()` returns file contents if it has been buffered
create returns File	create a new buffered file `function create(string filename, string description)`
createDirect returns File	create a new unbuffered disk file `function createDirect(string filename, string description)`
exists returns integer, 0 .. 1 (false/true)	test if a file exists `function exists()` Sample: File.exists("default.sim") -> return 0 or 1
flush doesn't return a value	flush `function flush()` useful for unbuffered disk files only (openDirect, appendDirect)
new returns File	create a new memory file `function new()`
newFromString returns File	create a new memory file with string contents `function newFromString(string text)`
open returns File	open existing file for reading `function open(string filename)`
readLine returns string	read line `function readLine()`
readObject doesn't return a value	read object `function readObject(object)`
readUntilEOF returns string	read everything `function readUntilEOF()`
writeComment doesn't return a value	write comment string `function writeComment(string anything)`
writeNameObject doesn't return a value	write object with alternate name `function writeNameObject(string name, object)`
writeObject doesn't return a value	write object `function writeObject(object)`
writeObjectBegin doesn't return a value	write object header `function writeObjectBegin(object)`
writeObjectEnd doesn't return a value	finish object `function writeObjectEnd()`
writeObjectField doesn't return a value	write single field `function writeObjectField(object, untyped field_index_or_name)`
writeObjectFieldForce doesn't return a value	write single field `function writeObjectFieldForce(object, untyped field_index_or_name)`
writeObjectFields doesn't return a value	write all fields `function writeObjectFields(object)`
writeObjectFieldsForce doesn't return a value	write all fields `function writeObjectFieldsForce(object)`
writeString doesn't return a value	write anything `function writeString(untyped anything)`