amn::IFileManager Class Reference

An abstraction layer for file input/output. More...

#include <IFileManager.h>

Inheritance diagram for amn::IFileManager:

List of all members.

Public Member Functions
	IFileManager (IEngine *e)
virtual	~IFileManager ()
virtual IEngine *	getEngine ()=0
	Returns a pointer to the engine.
virtual IReadFile *	openFileForReading (const char *filename)=0
virtual IReadFileXML *	openXMLFileForReading (const char *filename)=0
virtual IWriteFile *	openFileForWriting (const char *filename)=0
virtual void	closeFile (IReadFile *file)=0
	Closes and deallocates a file pointer.
virtual void	closeFile (IReadFileXML *file)=0
	Closes and deallocates an XML file pointer.
virtual void	closeFile (IWriteFile *file)=0
	Closes and deallocates a file pointer.
Protected Attributes
IEngine *	engine
IArray< IReadFile * >	openInputs
IArray< IReadFileXML * >	openInputsXML
IArray< IWriteFile * >	openOutputs

---

Detailed Description

An abstraction layer for file input/output.

---

Constructor & Destructor Documentation

amn::IFileManager::IFileManager (  IEngine *  e  )  [inline]

virtual amn::IFileManager::~IFileManager (   )  [inline, virtual]

---

Member Function Documentation

virtual void amn::IFileManager::closeFile (  IWriteFile *  file  )  [pure virtual]

Closes and deallocates a file pointer.

virtual void amn::IFileManager::closeFile (  IReadFileXML *  file  )  [pure virtual]

Closes and deallocates an XML file pointer.

virtual void amn::IFileManager::closeFile (  IReadFile *  file  )  [pure virtual]

Closes and deallocates a file pointer.

virtual IEngine* amn::IFileManager::getEngine (   )  [pure virtual]

Returns a pointer to the engine.

virtual IReadFile* amn::IFileManager::openFileForReading (  const char *  filename  )  [pure virtual]

Opens a file for reading. Parameters: File  name of the file to open. Returns: A pointer to the newly opened file. Returns NULL if an error occurred.

virtual IWriteFile* amn::IFileManager::openFileForWriting (  const char *  filename  )  [pure virtual]

Opens a file for writing. Parameters: File  name of the file to open, if the file does not exist, then it will be created. Returns: A pointer to the newly opened file. Returns NULL if an error occurred.

virtual IReadFileXML* amn::IFileManager::openXMLFileForReading (  const char *  filename  )  [pure virtual]

Opens an XML file for reading and parsing. Parameters: File  name of the file to open. Returns: A pointer to the open XML file. Returns NULL if an error occurred.

---

Member Data Documentation

IEngine* amn::IFileManager::engine [protected]

IArray<IReadFile*> amn::IFileManager::openInputs [protected]

IArray<IReadFileXML*> amn::IFileManager::openInputsXML [protected]

IArray<IWriteFile*> amn::IFileManager::openOutputs [protected]

---

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

• includes/IFileManager.h

---