FileInterface Object

Name

Description

Attributes

AppendMode

If enabled, the stream position is set to the end of the file when the file is initially opened. Otherwise the stream position will be at the beginning of the file. This cannot be changed while the file is open.

Type:   Variable

Access: Read/Write

AtEndMode

If enabled, the stream position is set to the end of the file after each write operation. This cannot be changed while the file is open.

Type:   Variable

Access: Read/Write

BinaryMode

Determines if the file stream is in binary mode, rather than text mode. This cannot be changed while the file is open.

Type:   Variable

Access: Read/Write

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

DisplayName

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

EOF

Returns 1 if the current stream position is the end of the file.

Type:   Variable

Access: Read-Only

Fail

Returns 1 if an error has occurred, other than an EOF, after an I/O operation.

Type:   Variable

Access: Read-Only

Filename

The name of the file to be opened for the file stream.

Type:   String

Access: Read/Write

FormatFlags

The format flags affect the way data is read and is written for certain data types. To set a format flag, set the value at the corresponding array index to 1. To unset a format flag, set the value at the corresponding array index to 0. The format flags indicies are as follows:

index = 0 name = boolalpha definition: read/write boolean values as names (i.e. true/false).

index = 1 name = dec definition: read/write integer values in decimal base format.

index = 2 name = fixed definition: write floating point values in fixed-point notation.

index = 3 name = hex definition: read/write integer values in hexadecimal base format.

index = 4 name = internal definition: the output is padded with spaces at an internal point enlarging the output up to the field width.

index = 5 name = left definition: the output is padded at the end enlarging the output up to the field width.

index = 6 name = oct definition: read/write integer values in octal base format.

index = 7 name = right definition: the output is padded at the beginning enlarging the output up to the field width.

index = 8 name = scientific definition: write floating-point values in scientific notation.

index = 9 name = showbase definition: write integer values preceded by the numeric base.

index = 10 name = showpoint definition: write floating-point values including always the decimal point.

index = 11 name = showpos definition: write non-negative values preceded by a plus sign (+).

index = 12 name = shipws definition: skip leading whitespaces on certain input operations.

index = 13 name = unitbuf definition: flush output after each inserting operation.

index = 14 name = uppercase definition: write uppercase letters replacing certain lowercase letters.

Type:   Array

Access: Read/Write

GetLastError

The error code value for the last error that occurred.

Type:   Variable

Access: Read-Only

GetLastErrorString

The string representation of the error code value for the last error that occurred.

Type:   String

Access: Read-Only

GetPosition

The position of the get pointer of an input stream. The get pointer determines the next location of the file stream to be read in.

Type:   Variable

Access: Read/Write

IsBad

Returns 1 if the badbit error flag has been set for the file stream.

Type:   Variable

Access: Read-Only

IsGood

Returns 1 if no error flags are set for the file stream.

Type:   Variable

Access: Read-Only

IsOpen

Returns 1 if a file stream is open for I/O operations.

Type:   Variable

Access: Read-Only

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

Precision

The maximum number of digits that shall be written during output operations to express floating point numbers. This includes both digits before and after the decimal point.

Type:   Variable

Access: Read/Write

PutPosition

The position of the put pointer in an output file stream. The put pointer determines the next location of the file stream to be written to.

Type:   Variable

Access: Read/Write

ReadMode

Determines if the FileInterface can read from the specified file. This cannot be changed while the file is open.

Type:   Variable

Access: Read/Write

TruncateMode

Determines if the contents of the specified file will be cleared when opened. This cannot be changed while the file is open.

Type:   Variable

Access: Read/Write

Width

The minimum number of characters to be written in some output representations.

Type:   Variable

Access: Read/Write

WriteMode

Determines if the FileInterface can write to the specified file. This cannot be changed while the file is open.

Type:   Variable

Access: Read/Write

Name

Description

Clear

Clears any error state for the file stream and returns a flag indicating if the clear was successful.

ClearSavedStates

Clears previous saved states for this object.

Close

Closes a file for I/O operations. The file stream buffer is released from its association with the currently open file, and returns a flag indicating if the close was successful.

Flush

Synchronizes the file stream buffer with the physical media associated with it. Places the contents within the file stream buffer into the file, and returns a flag indicating if the flush was successful.

Get

Returns the string of characters which is extracted from the file stream. The user can specify whether to extract only the next character, a specified number of characters, or a specified number of characters up until a specified delimiter is encountered.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

GetLine

Returns any number of characters which are extracted from the file stream until a specified delimiter, line feed (\n), or EOF is encountered. Use the Put method to preserve line feeds because they are ignored by GetLine. The user can specify whether to use the line feed or a custom delimiter to mark the end of a line.

IWrite

Writes a Variable value to the FileInterface as an integer.

Open

Opens a file for I/O operations, and returns a flag indicating if the Open was successful. The file stream buffer is associated with the file specified by FileInterface.Filename.

Peek

Returns the next character without extracting it from the file stream. If the end of the file is encountered, "EOF" is returned.

Put

Writes the specified String argument to the file stream.

PutBack

Places a specified character back into the stream.

PutLine

Writes the specified String and a trailing line feed (\n) to the file stream.

PutToFile

Convert the object state to FreeFlyer object xml and write to a file.

PutToString

Convert the object state to FreeFlyer object xml and return as a string.

Read

Reads the number of characters specified by the Variable argument from the file stream.

ReferenceEquals

Returns 1 if the argument refers to the calling object and 0 otherwise.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

SeekG

Sets the position of the "Get" pointer by changing its position by the amount specified by the input arguments. The Get pointer determines the next location to be read in the buffer associated to the input stream.

SeekP

Sets the position of the "Put" pointer by changing its position by the amount specified by the input arguments. The Put pointer determines the next location to be written in the buffer associated to the output stream.

Write

Writes the specified arguments to the file stream. If a variable argument is written, this method returns a 1 if the write was successful or a 0 if unsuccessful. If a string argument is written, this method returns the number of characters written to the file.