IECore::FileIndexedIO Class Reference

#include <FileIndexedIO.h>

Inheritance diagram for IECore::FileIndexedIO:

List of all members.

Public Member Functions
	IE_CORE_DECLAREMEMBERPTR (FileIndexedIO)
	FileIndexedIO (const std::string &path, const IndexedIO::EntryID &root, IndexedIO::OpenMode mode)
	Open an existing device or create a new one.
virtual IndexedIO::OpenMode	openMode () const
	Returns the mode with which the interface was created.
IndexedIOInterfacePtr	resetRoot () const
	Returns a new interface with the root set to the current directory.
void	chdir (const IndexedIO::EntryID &name)
void	mkdir (const IndexedIO::EntryID &name)
IndexedIO::EntryID	pwd ()
	Retrieve the current directorys, relative to the root.
IndexedIO::EntryList	ls (IndexedIOFilterPtr f=0)
IndexedIO::Entry	ls (const IndexedIO::EntryID &name)
	Return details of a specific entry.
unsigned long	rm (const IndexedIO::EntryID &name)
void	write (const IndexedIO::EntryID &name, const float *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const double *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const half *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const int *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const int64_t *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const uint64_t *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const unsigned int *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const char *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const unsigned char *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const std::string *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const short *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const unsigned short *x, unsigned long arrayLength)
void	write (const IndexedIO::EntryID &name, const float &x)
void	write (const IndexedIO::EntryID &name, const double &x)
void	write (const IndexedIO::EntryID &name, const half &x)
void	write (const IndexedIO::EntryID &name, const int &x)
void	write (const IndexedIO::EntryID &name, const int64_t &x)
void	write (const IndexedIO::EntryID &name, const uint64_t &x)
void	write (const IndexedIO::EntryID &name, const std::string &x)
void	write (const IndexedIO::EntryID &name, const unsigned int &x)
void	write (const IndexedIO::EntryID &name, const char &x)
void	write (const IndexedIO::EntryID &name, const unsigned char &x)
void	write (const IndexedIO::EntryID &name, const short &x)
void	write (const IndexedIO::EntryID &name, const unsigned short &x)
void	read (const IndexedIO::EntryID &name, float *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, double *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, half *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, int *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, int64_t *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, uint64_t *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, unsigned int *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, char *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, unsigned char *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, std::string *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, short *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, unsigned short *&x, unsigned long arrayLength)
void	read (const IndexedIO::EntryID &name, float &x)
void	read (const IndexedIO::EntryID &name, double &x)
void	read (const IndexedIO::EntryID &name, half &x)
void	read (const IndexedIO::EntryID &name, int &x)
void	read (const IndexedIO::EntryID &name, int64_t &x)
void	read (const IndexedIO::EntryID &name, uint64_t &x)
void	read (const IndexedIO::EntryID &name, std::string &x)
void	read (const IndexedIO::EntryID &name, unsigned int &x)
void	read (const IndexedIO::EntryID &name, char &x)
void	read (const IndexedIO::EntryID &name, unsigned char &x)
void	read (const IndexedIO::EntryID &name, short &x)
void	read (const IndexedIO::EntryID &name, unsigned short &x)
ConstCharVectorDataPtr	buf ()
Static Public Member Functions
static IndexedIOInterfacePtr	create (const std::string &path, const IndexedIO::EntryID &root, IndexedIO::OpenMode mode)
static bool	canRead (const std::string &path)
Protected Member Functions
	FileIndexedIO (const FileIndexedIO &other, IndexedIO::OpenMode mode)
bool	exists (const IndexedIOPath &path, IndexedIO::EntryType e) const
	Check for existence of the entry with specified type.
bool	exists (const IndexedIO::EntryID &name) const
	Check for existence of the entry with any type.
unsigned long	rm (const IndexedIO::EntryID &name, bool throwIfNonExistent)
template<typename T >
void	write (const IndexedIO::EntryID &name, const T *x, unsigned long arrayLength)
template<typename T >
void	read (const IndexedIO::EntryID &name, T *&x, unsigned long arrayLength) const
template<typename T >
void	write (const IndexedIO::EntryID &name, const T &x)
template<typename T >
void	read (const IndexedIO::EntryID &name, T &x) const
	IE_CORE_DECLAREPTR (Index)
	IE_CORE_DECLAREPTR (IndexedFile)
	IE_CORE_DECLAREPTR (Node)
bool	find (const IndexedIO::EntryID &name, NodePtr &node) const
NodePtr	insert (const IndexedIO::EntryID &name)
boost::optional< Imf::Int64 >	flush ()
std::iostream *	device ()
void	open (std::iostream *device, const IndexedIO::EntryID &root, IndexedIO::OpenMode mode, bool newStream=false)
Protected Attributes
IndexedIOPath	m_currentDirectory
IndexedIO::OpenMode	m_mode
	The mode this device was opened with.
IndexedFilePtr	m_indexedFile
NodePtr	m_currentDirectoryNode
NodePtr	m_rootDirectoryNode

---

Detailed Description

An implementation of IndexedIOInterface which operates within a single file on disk.

Todo:

Most of the implementation of this class would be better of in a "StreamIndexedIO" class which FileIndexedIO and MemoryIndexedIO derive from. MemoryIndexedIO wasn't implemented that cleanly in the first place due to the necessity to maintain binary compatibility.

---

Member Function Documentation

void IECore::FileIndexedIO::chdir

(

const IndexedIO::EntryID &

name

)

[virtual]

Relocate to a different directory within the current device. Attempting to navigate above the current root directory will throw an exception.

Parameters:

name	The directory to relocate to. Can be an absolute or relative path. Special directory names such as ".", "..", and "/" are supported.

Implements IECore::IndexedIOInterface.

static IndexedIOInterfacePtr IECore::FileIndexedIO::create	(	const std::string &	path,
		const IndexedIO::EntryID &	root,
		IndexedIO::OpenMode	mode
	)		[static]

Create an instance of a subclass which is able to open the IndexedIO structure found at "path". Files can be opened for Read, Overwrite, or Append. During "Read" operations it is not permitted to make any modifications to the underlying files. When opening a device in "Write" mode its contents below the root directory are removed. For "Append" operations it is possible to write new files, or overwrite existing ones. It is not possible to overwrite entire directories, however.

Parameters:

path	A file or directory on disk. The appropriate reader for reading/writing is determined by the path's extension.
root	The root point to 'mount' the structure. Paths above the root in the hierarchy are inaccessible.
mode	A bitwise-ORed combination of constants which determine how the file system should be accessed.

Reimplemented from IECore::IndexedIOInterface.

std::iostream* IECore::FileIndexedIO::device

(

)

[protected]

Todo:

Add virtual method to obtain device name ( e.g filename, "memory", etc )

boost::optional<Imf::Int64> IECore::FileIndexedIO::flush

(

)

[protected]

Todo:

Should be virtual

IndexedIO::EntryList IECore::FileIndexedIO::ls

(

IndexedIOFilterPtr

f = 0

)

[virtual]

Find file and/or directory names contained within the current index. Short names to the files/directories are always returned.

Parameters:

f	A subclass of IndexedIOFilter to allow removal of entries which are of no conern.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::mkdir

(

const IndexedIO::EntryID &

name

)

[virtual]

Create a new directory. Automatically creates parent directories if needed.

Parameters:

name	The directory to create.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		unsigned int &	x
	)		[virtual]

Read an unsigned int from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		half *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a half array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		int *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read an int array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		int &	x
	)		[virtual]

Read an int from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		int64_t *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a long array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		uint64_t *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a long array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		unsigned int *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read an unsigned int array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		unsigned short *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read an unsigned short array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		char *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a char array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		unsigned char *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read an unsigned char array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		std::string *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a string array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		short *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a short array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		unsigned short &	x
	)		[virtual]

Read an unsigned char from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		double *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a double array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		float &	x
	)		[virtual]

Read a float from an existing file.

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		double &	x
	)		[virtual]

Read a double from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		half &	x
	)		[virtual]

Read a half from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		int64_t &	x
	)		[virtual]

Read a long from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		uint64_t &	x
	)		[virtual]

Read a long from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		std::string &	x
	)		[virtual]

Read a string from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		char &	x
	)		[virtual]

Read a char from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		unsigned char &	x
	)		[virtual]

Read an unsigned char from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		short &	x
	)		[virtual]

Read a short from an existing file

Parameters:

name	The name of the file to be read
x	Returns the data read.

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::read	(	const IndexedIO::EntryID &	name,
		float *&	x,
		unsigned long	arrayLength
	)		[virtual]

Read a float array from an existing file.

Parameters:

name	The name of the file to be read
x	The buffer to fill. If 0 is passed, then memory is allocated and should be freed by the caller.
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

unsigned long IECore::FileIndexedIO::rm

(

const IndexedIO::EntryID &

name

)

[virtual]

Remove a specified file or directory. If an attempt is made to delete the current directory, the operation is permitted but the current directory is then undefined and must be reset using chdir with an absolute path.

Implements IECore::IndexedIOInterface.

unsigned long IECore::FileIndexedIO::rm	(	const IndexedIO::EntryID &	name,
		bool	throwIfNonExistent
	)		[protected]

Variant of "rm" which allows exceptions to be optionally thrown if the entry to remove does not exist.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const char *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified char array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const unsigned short &	x
	)		[virtual]

Create a new file containing the specified unsigned short

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const std::string *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified string array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const unsigned short *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified unsigned short array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const float &	x
	)		[virtual]

Create a new file containing the specified float

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const double &	x
	)		[virtual]

Create a new file containing the specified double

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const float *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified float array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const int64_t &	x
	)		[virtual]

Create a new file containing the specified long

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const char &	x
	)		[virtual]

Create a new file containing the specified char

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const uint64_t &	x
	)		[virtual]

Create a new file containing the specified long

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const int64_t *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified unsigned long array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const unsigned char &	x
	)		[virtual]

Create a new file containing the specified unsigned char

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const unsigned int *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified unsigned int array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const unsigned char *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified unsigned char array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const half &	x
	)		[virtual]

Create a new file containing the specified half

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const short *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified short array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const int &	x
	)		[virtual]

Create a new file containing the specified int

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const half *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified half array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const unsigned int &	x
	)		[virtual]

Create a new file containing the specified unsigned int

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const uint64_t *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified unsigned long array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const int *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified unsigned int array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const double *	x,
		unsigned long	arrayLength
	)		[virtual]

Create a new file containing the specified double array contents

Parameters:

name	The name of the file to be written
x	The data to write
arrayLength	The number of elements in the array

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const std::string &	x
	)		[virtual]

Create a new file containing the specified string

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

void IECore::FileIndexedIO::write	(	const IndexedIO::EntryID &	name,
		const short &	x
	)		[virtual]

Create a new file containing the specified short

Parameters:

name	The name of the file to be written
x	The data to write

Implements IECore::IndexedIOInterface.

---

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

• include/IECore/FileIndexedIO.h