Inherits SimObject, and SimObject.

Methods
void	clear ()

void	clear ()

bool	deleteLine (lineIndex)

bool	deleteLine (lineIndex)

void	dump (filename[, header])

void	dump (filename[, header])

int	getLineIndexByTag (tag)

int	getLineIndexByTag (tag)

int	getLineTag (line)

int	getLineTag (line)

string	getLineText (index)

string	getLineText (index)

string	getLineTextByTag (tag)

string	getLineTextByTag (tag)

int	getNumLines ()

int	getNumLines ()

bool	insertLine (pos, msg[, tag])

bool	insertLine (pos, msg[, tag])

bool	popBackLine ()

bool	popBackLine ()

bool	popFrontLine ()

bool	popFrontLine ()

void	pushBackLine (msg[, tag])

void	pushBackLine (msg[, tag])

void	pushFrontLine (msg[, tag])

void	pushFrontLine (msg[, tag])

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

void MessageVector::clear ( )

Clear the message vector.

Returns: No return value

void MessageVector::clear ( )

Clear the message vector.

Returns: No return value

bool MessageVector::deleteLine ( lineIndex )

Delete the line at the specified position.

Parameters

lineIndex The line to delete in this vector.

Returns: No return value.

See Also: insertLine, pushBackLine, pushFrontLine

bool MessageVector::deleteLine ( lineIndex )

Delete the line at the specified position.

Parameters

lineIndex The line to delete in this vector.

Returns: No return value.

See Also: insertLine, pushBackLine, pushFrontLine

void MessageVector::dump ( filename [, header] )

Dump the message vector to a file, optionally prefixing the file with a header.

Parameters

filename	The file to dump this vector to.
header	An optional string containing data to dump to the new file prior to dumping the vector.

Returns: No return value

void MessageVector::dump ( filename [, header] )

Dump the message vector to a file, optionally prefixing the file with a header.

Parameters

filename	The file to dump this vector to.
header	An optional string containing data to dump to the new file prior to dumping the vector.

Returns: No return value

int MessageVector::getLineIndexByTag ( tag )

Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found.

Parameters

tag	A special marker, possibly embedded in one or more lines in the vector.

Returns: Returns the line number of the first line found with the specified tag, otherwise returns -1.

See Also: insertLine, pushBackLine, pushFrontLine

int MessageVector::getLineIndexByTag ( tag )

Scan through the vector, returning the line number of the first line that matches the specified tag; else returns -1 if no match was found.

Parameters

tag	A special marker, possibly embedded in one or more lines in the vector.

Returns: Returns the line number of the first line found with the specified tag, otherwise returns -1.

See Also: insertLine, pushBackLine, pushFrontLine

int MessageVector::getLineTag ( line )

Use the getLineTag method to retrieve the tag for the specified line.

Parameters

line	Line to search for tag in.

Returns: Returns a tag value or 0 indicating no tag found.

See Also: insertLine, pushBackLine, pushFrontLine

int MessageVector::getLineTag ( line )

Use the getLineTag method to retrieve the tag for the specified line.

Parameters

line	Line to search for tag in.

Returns: Returns a tag value or 0 indicating no tag found.

See Also: insertLine, pushBackLine, pushFrontLine

string MessageVector::getLineText ( index )

Use the getLineIndex method to get the text at a specified line.

Parameters

index The index in the vector from which to retrieve a line of text.

Returns: Returns the text at the specified line, or NULL indicating a bad index.

See Also: insertLine, pushBackLine, pushFrontLine

string MessageVector::getLineText ( index )

Use the getLineIndex method to get the text at a specified line.

Parameters

index The index in the vector from which to retrieve a line of text.

Returns: Returns the text at the specified line, or NULL indicating a bad index.

See Also: insertLine, pushBackLine, pushFrontLine

string MessageVector::getLineTextByTag ( tag )

Use the getLineTextByTag method to scan through the lines in the vector, returning the first line that has a matching tag.

Parameters

tag	An special marker that may have been used when creating lines in the vector.

Returns: Returns the contents of the first line found with a matching tag or NULL indicating no match.

See Also: insertLine, pushBackLine, pushFrontLine

string MessageVector::getLineTextByTag ( tag )

Use the getLineTextByTag method to scan through the lines in the vector, returning the first line that has a matching tag.

Parameters

tag	An special marker that may have been used when creating lines in the vector.

Returns: Returns the contents of the first line found with a matching tag or NULL indicating no match.

See Also: insertLine, pushBackLine, pushFrontLine

int MessageVector::getNumLines ( )

Use the getNumLines method to get the number of lines in the vector.

Returns: Returns an integer value equal to the line count for this vector.

See Also: insertLine, pushBackLine, pushFrontLine

int MessageVector::getNumLines ( )

Use the getNumLines method to get the number of lines in the vector.

Returns: Returns an integer value equal to the line count for this vector.

See Also: insertLine, pushBackLine, pushFrontLine

bool MessageVector::insertLine	(	pos	,
		msg	[, tag]
	)

Use the insertLine method to insert a new line into the vector at the specified position. An optional tag may also be applied.

Parameters

pos	The line at which to insert the new text.
msg	The text to add to this control.
tag	An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.

Returns: No return value.

See Also: pushBackLine, pushFrontLine

bool MessageVector::insertLine	(	pos	,
		msg	[, tag]
	)

Use the insertLine method to insert a new line into the vector at the specified position. An optional tag may also be applied.

Parameters

pos	The line at which to insert the new text.
msg	The text to add to this control.
tag	An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.

Returns: No return value.

See Also: pushBackLine, pushFrontLine

bool MessageVector::popBackLine ( )

Use the popBackLine method to pop a line from the back of the list; destroys the line.

Returns: No return value.

See Also: insertLine, pushBackLine, pushFrontLine

bool MessageVector::popBackLine ( )

Use the popBackLine method to pop a line from the back of the list; destroys the line.

Returns: No return value.

See Also: insertLine, pushBackLine, pushFrontLine

bool MessageVector::popFrontLine ( )

Use the popFrontLine method to pop a line from the front of the vector, destroying the line.

Returns: No return value.

See Also: insertLine, pushBackLine, pushFrontLine

bool MessageVector::popFrontLine ( )

Use the popFrontLine method to pop a line from the front of the vector, destroying the line.

Returns: No return value.

See Also: insertLine, pushBackLine, pushFrontLine

void MessageVector::pushBackLine ( msg [, tag] )

Use the pushBackLine method to push a line onto the back of the list.

Parameters

msg	The text to add to this control.
tag	An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.

Returns: No return value.

See Also: popBackLine, popFrontLine, insertLine, pushFrontLine

void MessageVector::pushBackLine ( msg [, tag] )

Use the pushBackLine method to push a line onto the back of the list.

Parameters

msg	The text to add to this control.
tag	An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.

Returns: No return value.

See Also: popBackLine, popFrontLine, insertLine, pushFrontLine

void MessageVector::pushFrontLine ( msg [, tag] )

Use the pushFrontLine method to push a line onto the front of the vector.

Parameters

msg	The text to add to this control.
tag	An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.

Returns: No return value.

See Also: popBackLine, popFrontLine, insertLine, pushBackLine

void MessageVector::pushFrontLine ( msg [, tag] )

Use the pushFrontLine method to push a line onto the front of the vector.

Parameters

msg	The text to add to this control.
tag	An optional tag to tag this line with. If not tag is supplied, a tag of 0 is used.

Returns: No return value.

See Also: popBackLine, popFrontLine, insertLine, pushBackLine

Member Data Documentation

bool MessageVector::canSaveDynamicFields

string MessageVector::class

Script SuperClass of object.

string MessageVector::internalName

SimObjectPtr MessageVector::parentGroup

Group hierarchy parent of the object.

string MessageVector::superclass

Script Class of object.