Inherits SimObject, and SimObject.

Inherited by FileStreamObject, and FileStreamObject.

Methods
bool	copyFrom (StreamObject other)

bool	copyFrom (StreamObject other)

int	getPosition ()

int	getPosition ()

string	getStatus ()

string	getStatus ()

int	getStreamSize ()

int	getStreamSize ()

bool	isEOF ()

bool	isEOF ()

bool	isEOS ()

bool	isEOS ()

string	readLine ()

string	readLine ()

string	readLongString (maxLength)

string	readLongString (maxLength)

string	readString ()

string	readString ()

string	readSTString ([caseSensitive=false])

string	readSTString ([caseSensitive=false])

bool	setPosition (newPosition)

bool	setPosition (newPosition)

void	writeLine (line)

void	writeLine (line)

void	writeLongString (maxLength, string)

void	writeLongString (maxLength, string)

void	writeString (string,[maxLength=255])

void	writeString (string,[maxLength=255])

Methods inherited from SimObject
void	addFieldFilter (fieldName)

void	addFieldFilter (fieldName)

string	call (%args)

string	call (%args)

int	clone ([bool copyDynamicFields?=false])

int	clone ([bool copyDynamicFields?=false])

void	delete ()

void	delete ()

void	dump ()

void	dump ()

void	dumpClassHierarchy ()

void	dumpClassHierarchy ()

string	getClassName ()

string	getClassName ()

string	getClassNamespace ()

string	getClassNamespace ()

string	getDynamicField (index)

string	getDynamicField (index)

int	getDynamicFieldCount ()

int	getDynamicFieldCount ()

string	getField (int index)

string	getField (int index)

int	getFieldCount ()

int	getFieldCount ()

string	getFieldType (fieldName)

string	getFieldType (fieldName)

string	getFieldValue (fieldName)

string	getFieldValue (fieldName)

int	getGroup ()

int	getGroup ()

int	getId ()

int	getId ()

string	getInternalName ()

string	getInternalName ()

string	getName ()

string	getName ()

string	getProgenitorFile ()

string	getProgenitorFile ()

string	getSuperClassNamespace ()

string	getSuperClassNamespace ()

int	getType ()

int	getType ()

bool	isChildOfGroup ()

bool	isChildOfGroup ()

bool	isMemberOfClass (string classname)

bool	isMemberOfClass (string classname)

bool	isMethod (string method name)

bool	isMethod (string method name)

bool	isTimerActive ()

bool	isTimerActive ()

void	removeFieldFilter (fieldName)

void	removeFieldFilter (fieldName)

bool	save (fileName,[selectedOnly])

bool	save (fileName,[selectedOnly])

int	schedule (time, command,< arg1...argN >)

int	schedule (time, command,< arg1...argN >)

void	setClassNamespace ()

void	setClassNamespace ()

bool	setFieldValue (fieldName, value)

bool	setFieldValue (fieldName, value)

void	setInternalName ()

void	setInternalName ()

void	setName (newName)

void	setName (newName)

void	setProgenitorFile (file)

void	setProgenitorFile (file)

void	setSuperClassNamespace ()

void	setSuperClassNamespace ()

bool	startTimer (callbackFunction, float timePeriod,[repeat])

bool	startTimer (callbackFunction, float timePeriod,[repeat])

void	stopTimer ()

void	stopTimer ()

Fields
SimBase
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

Namespace Linking
string	superclass

string	class

Fields inherited from SimObject
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Methods

bool StreamObject::copyFrom ( StreamObject other )

Copies stream contents from current position

Parameters

other The StreamObject from which to copy

Returns: Returns true on success, and false otherwise.

bool StreamObject::copyFrom ( StreamObject other )

Copies stream contents from current position

Parameters

other The StreamObject from which to copy

Returns: Returns true on success, and false otherwise.

int StreamObject::getPosition ( )

Returns: Returns the current position in the stream as an integer or zero if failed

int StreamObject::getPosition ( )

Returns: Returns the current position in the stream as an integer or zero if failed

string StreamObject::getStatus ( )

Gets the current status of the StreamObject

Returns: The current status as a string (Ok, IOError, EOS, IllegalCall, Closed, UnknownError, Invalid)

string StreamObject::getStatus ( )

Gets the current status of the StreamObject

Returns: The current status as a string (Ok, IOError, EOS, IllegalCall, Closed, UnknownError, Invalid)

int StreamObject::getStreamSize ( )

Get the size of the stream

Returns: The size of the stream as an integer

int StreamObject::getStreamSize ( )

Get the size of the stream

Returns: The size of the stream as an integer

bool StreamObject::isEOF ( )

Test for end of file stream (identical to isEOS()

Returns: Returns true if at the end of the stream, false otherwise.

See Also: isEOS

bool StreamObject::isEOF ( )

Test for end of file stream (identical to isEOS()

Returns: Returns true if at the end of the stream, false otherwise.

See Also: isEOS

bool StreamObject::isEOS ( )

Test for end of stream

Returns: Returns true if at the end of the stream, false otherwise.

bool StreamObject::isEOS ( )

Test for end of stream

Returns: Returns true if at the end of the stream, false otherwise.

string StreamObject::readLine ( )

Read the stream until '
' or EOS

Returns: A string containing the read line or an empty string if failed

string StreamObject::readLine ( )

Read the stream until '
' or EOS

Returns: A string containing the read line or an empty string if failed

string StreamObject::readLongString ( maxLength )

Reads a string of provided length from the stream buffer.

Parameters

The	maximum length to read in

Returns: The requested string

string StreamObject::readLongString ( maxLength )

Reads a string of provided length from the stream buffer.

Parameters

The	maximum length to read in

Returns: The requested string

string StreamObject::readString ( )

Reads a string from a stream buffer

Returns: The string or an empty string if failed.

string StreamObject::readString ( )

Reads a string from a stream buffer

Returns: The string or an empty string if failed.

string StreamObject::readSTString ( )

Read a String and insert it into a StringTable

Parameters

caseSensitive A boolean representing whether the parser should ignore case or not (default false)

Returns: Returns the string, or empty string if failed

string StreamObject::readSTString ( )

Read a String and insert it into a StringTable

Parameters

caseSensitive A boolean representing whether the parser should ignore case or not (default false)

Returns: Returns the string, or empty string if failed

bool StreamObject::setPosition ( newPosition )

Resets the current stream position

Parameters

The	desired index

Returns: Returns true if succeeded, flase otherwise

bool StreamObject::setPosition ( newPosition )

Resets the current stream position

Parameters

The	desired index

Returns: Returns true if succeeded, flase otherwise

void StreamObject::writeLine ( line )

Writes a line of text to the stream buffer

Parameters

The	line to write

Returns: No return value.

void StreamObject::writeLine ( line )

Writes a line of text to the stream buffer

Parameters

The	line to write

Returns: No return value.

void StreamObject::writeLongString	(	maxLength	,
		string
	)

Writes a string to buffer or provided length

Parameters

maxLength	The maximum length to write
string	The string to write

Returns: No return value

void StreamObject::writeLongString	(	maxLength	,
		string
	)

Writes a string to buffer or provided length

Parameters

maxLength	The maximum length to write
string	The string to write

Returns: No return value

void StreamObject::writeString ( string )

Write a string to the stream buffer

Parameters

string	The string to write
maxLength	The maximum length to write (default 255).

Returns: No return value.

void StreamObject::writeString ( string )

Write a string to the stream buffer

Parameters

string	The string to write
maxLength	The maximum length to write (default 255).

Returns: No return value.

Member Data Documentation

bool StreamObject::canSaveDynamicFields

string StreamObject::class

Script SuperClass of object.

string StreamObject::internalName

SimObjectPtr StreamObject::parentGroup

Group hierarchy parent of the object.

string StreamObject::superclass

Script Class of object.