Assimp::MemoryIOSystem Class Reference

Dummy IO system to read from a memory buffer. More...

#include <MemoryIOWrapper.h>

Inherits Assimp::IOSystem.

Public Member Functions
bool	ChangeDirectory (const std::string &path) override
	Will change the current directory to the given path.
void	Close (IOStream *pFile) override
	Closes the given file and releases all resources associated with it.
bool	ComparePaths (const char *one, const char *second) const override
	Compare two paths.
bool	CreateDirectory (const std::string &path) override
	CReates an new directory at the given path.
const std::string &	CurrentDirectory () const override
	Returns the top directory from the stack.
bool	DeleteFile (const std::string &file) override
	Will delete the given file.
bool	Exists (const char *pFile) const override
	Tests for the existence of a file at the given path.
char	getOsSeparator () const override
	Returns the directory separator.
	MemoryIOSystem (const uint8_t *buff, size_t len, IOSystem *io)
	Constructor.
IOStream *	Open (const char *pFile, const char *pMode="rb") override
	Open a new file with a given path.
bool	PopDirectory () override
	Pops the top directory from the stack.
bool	PushDirectory (const std::string &path) override
	Pushes a new directory onto the directory stack.
size_t	StackSize () const override
	Returns the number of directories stored on the stack.
	~MemoryIOSystem ()
	Destructor.
Public Member Functions inherited from Assimp::IOSystem
bool	ComparePaths (const std::string &one, const std::string &second) const
	For backward compatibility.
AI_FORCE_INLINE bool	Exists (const std::string &pFile) const
	For backward compatibility.
	IOSystem () AI_NO_EXCEPT
	Default constructor.
IOStream *	Open (const std::string &pFile, const std::string &pMode=std::string("rb"))
	For backward compatibility.
virtual	~IOSystem ()
	Virtual destructor.

Detailed Description

Dummy IO system to read from a memory buffer.

Constructor & Destructor Documentation

MemoryIOSystem()

Assimp::MemoryIOSystem::MemoryIOSystem ( const uint8_t *  buff, size_t  len, IOSystem *  io  )

inline

Constructor.

~MemoryIOSystem()

Assimp::MemoryIOSystem::~MemoryIOSystem ( )

inline

Destructor.

Member Function Documentation

ChangeDirectory()

bool Assimp::MemoryIOSystem::ChangeDirectory ( const std::string &  path )

inlineoverridevirtual

Will change the current directory to the given path.

Parameters

path	[in] The path to change to.

Returns

True, when the directory has changed successfully.

Reimplemented from Assimp::IOSystem.

Close()

void Assimp::MemoryIOSystem::Close ( IOStream *  pFile )

inlineoverridevirtual

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

Implements Assimp::IOSystem.

ComparePaths()

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

inlineoverridevirtual

Compare two paths.

Reimplemented from Assimp::IOSystem.

CreateDirectory()

bool Assimp::MemoryIOSystem::CreateDirectory ( const std::string &  path )

inlineoverridevirtual

CReates an new directory at the given path.

Parameters

path	[in] The path to create.

Returns

True, when a directory was created. False if the directory cannot be created.

Reimplemented from Assimp::IOSystem.

CurrentDirectory()

const std::string & Assimp::MemoryIOSystem::CurrentDirectory ( ) const

inlineoverridevirtual

Returns the top directory from the stack.

Returns

The directory on the top of the stack. Returns empty when no directory was pushed to the stack.

Reimplemented from Assimp::IOSystem.

DeleteFile()

bool Assimp::MemoryIOSystem::DeleteFile ( const std::string &  file )

inlineoverridevirtual

Will delete the given file.

Parameters

file	[in] The filename

Returns

true, if the file wase deleted, false if not.

Reimplemented from Assimp::IOSystem.

Exists()

bool Assimp::MemoryIOSystem::Exists ( const char *  pFile ) const

inlineoverridevirtual

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

Implements Assimp::IOSystem.

getOsSeparator()

char Assimp::MemoryIOSystem::getOsSeparator ( ) const

inlineoverridevirtual

Returns the directory separator.

Implements Assimp::IOSystem.

Open()

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

inlineoverridevirtual

Open a new file with a given path.

Implements Assimp::IOSystem.

PopDirectory()

bool Assimp::MemoryIOSystem::PopDirectory ( )

inlineoverridevirtual

Pops the top directory from the stack.

Returns

True, when a directory was on the stack. False if no directory was on the stack.

Reimplemented from Assimp::IOSystem.

PushDirectory()

bool Assimp::MemoryIOSystem::PushDirectory ( const std::string &  path )

inlineoverridevirtual

Pushes a new directory onto the directory stack.

Parameters

path	Path to push onto the stack.

Returns

True, when push was successful, false if path is empty.

Reimplemented from Assimp::IOSystem.

StackSize()

size_t Assimp::MemoryIOSystem::StackSize ( ) const

inlineoverridevirtual

Returns the number of directories stored on the stack.

Returns

The number of directories of the stack.

Reimplemented from Assimp::IOSystem.

---

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

• MemoryIOWrapper.h