#include <fileStreamObject.h>

Inheritance diagram for FileStreamObject:

Public Member Functions
	FileStreamObject ()

virtual	~FileStreamObject ()

	DECLARE_CONOBJECT (FileStreamObject)

virtual bool	onAdd ()
	Called when the object is added to the sim. More...

bool	open (const char *filename, FileStream::AccessMode mode)
	Open a file. More...

void	close ()
	Close the file. More...

Public Member Functions inherited from StreamObject
	StreamObject ()

	StreamObject (Stream *stream)

virtual	~StreamObject ()

	DECLARE_CONOBJECT (StreamObject)

void	setStream (Stream *stream)
	Set the stream to allow reuse of the object. More...

Stream *	getStream ()
	Get the underlying stream. Used with setStream() to support object reuse. More...

const char *	getStatus ()
	Gets a printable string form of the status. More...

bool	isEOS ()

U32	getPosition () const
	Gets the position in the stream. More...

bool	setPosition (const U32 in_newPosition)
	Sets the position of the stream. Returns if the new position is valid or not. More...

U32	getStreamSize ()
	Gets the size of the stream. More...

const char *	readLine ()
	Reads a line from the stream. More...

void	writeLine (U8 *buffer)
	Writes a line to the stream. More...

const char *	readSTString (bool casesens=false)

const char *	readString ()
	Reads a string of maximum 255 characters long. More...

const char *	readLongString (U32 maxStringLen)

void	writeLongString (U32 maxStringLen, const char *string)

void	writeString (const char *stringBuf, S32 maxLen=255)
	Writes a string to the stream. More...

bool	copyFrom (StreamObject *other)
	Copy the contents of another stream into this one. More...

Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const

StringTableEntry	getSuperClassNamespace () const

void	setClassNamespace (const char *classNamespace)

void	setSuperClassNamespace (const char *superClassNamespace)

void	pushScriptCallbackGuard (void)

void	popScriptCallbackGuard (void)

S32	getScriptCallbackGuard (void)

virtual SimObject *	findObject (const char *name)

Namespace *	getNamespace ()
	Return the object's namespace. More...

const char *	tabComplete (const char *prevText, S32 baseLen, bool)

virtual void	dump ()

virtual void	dumpClassHierarchy ()

SimObject *	clone (const bool copyDynamicFields)

virtual void	copyTo (SimObject *object)

template<typename T >
bool	isType (void)

virtual bool	handlesConsoleMethod (const char fname, S32 routingId)

	DECLARE_CONOBJECT (SimObject)

Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list. More...

void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted. More...

void	clearNotify (SimObject *obj)
	Notify an object when we are cleared. More...

void	clearAllNotifications ()
	Remove all notifications for this object. More...

void	processDeleteNotifies ()
	Send out deletion notifications. More...

void	registerReference (SimObject **obj)

void	unregisterReference (SimObject **obj)

const char *	getDataField (StringTableEntry slotName, const char *array)

void	setDataField (StringTableEntry slotName, const char array, const char value)

const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)

void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)

const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)

void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)

StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)

U32	getDataFieldType (StringTableEntry slotName, const char *array)

SimFieldDictionary *	getFieldDictionary ()

void	clearDynamicFields (void)
	Clear all dynamic fields. More...

void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true. More...

bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true. More...

void	setInternalName (const char *newname)

StringTableEntry	getInternalName ()
	Get the internal of of this control. More...

virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File. More...

virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace. More...

SimObjectId	getId (void) const

StringTableEntry	getIdString (void) const

U32	getType () const

const StringTableEntry	getName (void) const

void	setId (SimObjectId id)

void	assignName (const char *name)

SimGroup *	getGroup () const

bool	isChildOfGroup (SimGroup *pGroup)

bool	isProperlyAdded () const

bool	isDeleted () const

bool	isRemoved () const

bool	isLocked ()

void	setLocked (bool b)

bool	isHidden ()

void	setHidden (bool b)

void	setProgenitorFile (const char *pFile)

StringTableEntry	getProgenitorFile (void) const

void	setPeriodicTimerID (const S32 timerID)

S32	getPeriodicTimerID (void) const

bool	isPeriodicTimerActive (void) const

bool	isSelected () const

bool	isExpanded () const

void	setSelected (bool sel)

void	setExpanded (bool exp)

void	setModDynamicFields (bool dyn)

void	setModStaticFields (bool sta)

	SimObject (const U8 namespaceLinkMask=LinkSuperClassName\|LinkClassName)

virtual	~SimObject ()

virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)) More...

virtual void	onRemove ()
	Called when the object is removed from the sim. More...

virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup. More...

virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup. More...

virtual void	onNameChange (const char *name)
	Called when the object's name is changed. More...

virtual void	onStaticModified (const char slotName, const char newValue=NULL)

virtual void	inspectPreApply ()

virtual void	inspectPostApply ()

virtual void	onDeleteNotify (SimObject *object)

virtual void	onEditorEnable ()
	Called when the editor is activated. More...

virtual void	onEditorDisable ()
	Called when the editor is deactivated. More...

bool	registerObject ()

bool	registerObject (U32 id)

bool	registerObject (const char *name)

bool	registerObject (const char *name, U32 id)

void	unregisterObject ()

void	deleteObject ()

bool	addToSet (SimObjectId)

bool	addToSet (const char *)

bool	removeFromSet (SimObjectId)

bool	removeFromSet (const char *)

virtual bool	writeField (StringTableEntry fieldname, const char *value)

virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)

virtual void	writeFields (Stream &stream, U32 tabStop)

virtual bool	writeObject (Stream *stream)

virtual bool	readObject (Stream *stream)

virtual void	buildFilterList ()

void	addFieldFilter (const char *fieldName)

void	removeFieldFilter (const char *fieldName)

void	clearFieldFilters ()

bool	isFiltered (const char *fieldName)

void	assignFieldsFrom (SimObject *obj)

void	assignDynamicFieldsFrom (SimObject *obj)

Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name. More...

virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep. More...

bool	setField (const char fieldName, const char value)
	Set the value of a field. More...

virtual	~ConsoleObject ()

const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified. More...

AbstractClassRep::FieldList &	getModifiableFieldList ()

bool &	getDynamicGroupExpand ()

S32	getClassId (U32 netClassGroup) const

const char *	getClassName () const

Protected Attributes
FileStream	mFileStream

Protected Attributes inherited from StreamObject
Stream *	mStream

Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object. More...

StringTableEntry	mIdString

Namespace *	mNameSpace

U32	mTypeMask

S32	mScriptCallbackGuard
	Whether the object is executing a script callback. More...

bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true More...

StringTableEntry	mInternalName
	Stores object Internal Name. More...

StringTableEntry	mClassName
	Stores the class name to link script class namespaces. More...

StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces. More...

U8	mNSLinkMask

Additional Inherited Members
Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }

Static Public Member Functions inherited from SimObject
static void	initPersistFields ()

Protected Types inherited from SimObject
enum	SimObjectNSLinkType { LinkClassName = BIT(0), LinkSuperClassName = BIT(1) }

Protected Member Functions inherited from SimObject
virtual void	onTamlPreWrite (void)
	Taml callbacks. More...

virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object. More...

virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object. More...

virtual void	onTamlPostRead (const TamlCustomNodes &customNodes)

virtual void	onTamlAddParent (SimObject *pParentObject)
	Called after Taml has finished reading the object and has added the object to any parent. More...

virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written. More...

virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read. More...

void	linkNamespaces ()

void	unlinkNamespaces ()

Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)

static bool	setSuperClass (void obj, const char data)

static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)

static bool	writeInternalName (void *obj, StringTableEntry pFieldName)

static bool	setParentGroup (void obj, const char data)

static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)

static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)

static bool	writeClass (void *obj, StringTableEntry pFieldName)

static SimObject::Notify *	allocNotify ()
	Get a free Notify structure. More...

static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free. More...

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Constructor & Destructor Documentation

FileStreamObject ( )

~FileStreamObject ( )

virtual

Member Function Documentation

void close ( )

Close the file.

See Also: open()

DECLARE_CONOBJECT ( FileStreamObject )

bool onAdd ( void )

virtual

Called when the object is added to the sim.

Reimplemented from StreamObject.

bool open	(	const char *	filename,
		FileStream::AccessMode	mode
	)

Open a file.

Parameters

filename	Name of file to open
mode	One of FileStream::Read, FileStream::Write, FileStream::ReadWrite or FileStream::WriteAppend

Returns: true for success, false for failure

See Also: close()

Member Data Documentation

FileStream mFileStream

protected

The documentation for this class was generated from the following files:

io/fileStreamObject.h
io/fileStreamObject.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation