Assimp::IOSystem Class Reference

CPP-API: Interface to the file system. More...

#include <IOSystem.hpp>

Inheritance diagram for Assimp::IOSystem:

Public Member Functions
	IOSystem ()
	Default constructor. More...
virtual	~IOSystem ()
	Virtual destructor. More...
AI_FORCE_INLINE bool	Exists (const std::string &pFile) const
	For backward compatibility. More...
virtual bool	Exists (const char *pFile) const =0
	Tests for the existence of a file at the given path. More...
virtual char	getOsSeparator () const =0
	Returns the system specific directory separator. More...
virtual IOStream *	Open (const char *pFile, const char *pMode="rb")=0
	Open a new file with a given path. More...
IOStream *	Open (const std::string &pFile, const std::string &pMode=std::string("rb"))
	For backward compatibility. More...
virtual void	Close (IOStream *pFile)=0
	Closes the given file and releases all resources associated with it. More...
virtual bool	ComparePaths (const char *one, const char *second) const
	Compares two paths and check whether the point to identical files. More...
bool	ComparePaths (const std::string &one, const std::string &second) const
	For backward compatibility. More...

Detailed Description

CPP-API: Interface to the file system.

Derive an own implementation from this interface to supply custom file handling to the importer library. If you implement this interface, you also want to supply a custom implementation for IOStream.

See also

Importer::SetIOHandler()

Constructor & Destructor Documentation

IOSystem()

AI_FORCE_INLINE Assimp::IOSystem::IOSystem

(

)

Default constructor.

Create an instance of your derived class and assign it to an Assimp::Importer instance by calling Importer::SetIOHandler().

~IOSystem()

AI_FORCE_INLINE Assimp::IOSystem::~IOSystem ( )

virtual

Virtual destructor.

It is safe to be called from within DLL Assimp, we're constructed on Assimp's heap.

Member Function Documentation

Close()

virtual void Assimp::IOSystem::Close ( IOStream *  pFile )

pure virtual

Closes the given file and releases all resources associated with it.

Parameters

pFile

The file instance previously created by Open().

ComparePaths() [1/2]

virtual bool Assimp::IOSystem::ComparePaths ( const char *  one, const char *  second  ) const

virtual

Compares two paths and check whether the point to identical files.

The dummy implementation of this virtual member performs a case-insensitive comparison of the given strings. The default IO system implementation uses OS mechanisms to convert relative into absolute paths, so the result can be trusted.

Parameters

one	First file
second	Second file

Returns

true if the paths point to the same file. The file needn't be existing, however.

ComparePaths() [2/2]

bool Assimp::IOSystem::ComparePaths ( const std::string &  one, const std::string &  second  ) const

inline

For backward compatibility.

See also

ComparePaths(const char*, const char*)

Exists() [1/2]

AI_FORCE_INLINE bool Assimp::IOSystem::Exists

(

const std::string &

pFile

)

const

For backward compatibility.

See also

Exists(const char*)

Exists() [2/2]

virtual bool Assimp::IOSystem::Exists ( const char *  pFile ) const

pure virtual

Tests for the existence of a file at the given path.

Parameters

pFile

Path to the file

Returns

true if there is a file with this path, else false.

getOsSeparator()

virtual char Assimp::IOSystem::getOsSeparator ( ) const

pure virtual

Returns the system specific directory separator.

Returns

System specific directory separator

Open() [1/2]

virtual IOStream* Assimp::IOSystem::Open ( const char *  pFile, const char *  pMode = "rb"  )

pure virtual

Open a new file with a given path.

When the access to the file is finished, call Close() to release all associated resources (or the virtual dtor of the IOStream).

Parameters

pFile	Path to the file
pMode	Desired file I/O mode. Required are: "wb", "w", "wt", "rb", "r", "rt".

Returns

New IOStream interface allowing the lib to access the underlying file.

Note

When implementing this class to provide custom IO handling, you probably have to supply an own implementation of IOStream as well.

Open() [2/2]

AI_FORCE_INLINE IOStream * Assimp::IOSystem::Open ( const std::string &  pFile, const std::string &  pMode = std::string("rb")  )

inline

For backward compatibility.

See also

Open(const char*, const char*)

---

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

• external/assimp-3.1.1/include/assimp/IOSystem.hpp