IECore::IndexedIOInterface Class Reference

#include <IndexedIOInterface.h>

Inheritance diagram for IECore::IndexedIOInterface:

List of all members.

Classes
struct	Description
Public Types
typedef IndexedIOInterfacePtr(*	CreatorFn )(const std::string &, const IndexedIO::EntryID &, IndexedIO::OpenMode)
Public Member Functions
	IE_CORE_DECLAREMEMBERPTR (IndexedIOInterface)
virtual	~IndexedIOInterface ()
virtual IndexedIO::OpenMode	openMode () const =0
	Returns the mode with which the interface was created.
virtual IndexedIOInterfacePtr	resetRoot () const =0
	Returns a new interface with the root set to the current directory.
virtual void	chdir (const IndexedIO::EntryID &name)=0
virtual void	mkdir (const IndexedIO::EntryID &name)=0
virtual IndexedIO::EntryID	pwd ()=0
	Retrieve the current directorys, relative to the root.
virtual IndexedIO::EntryList	ls (IndexedIOFilterPtr f=0)=0
virtual IndexedIO::Entry	ls (const IndexedIO::EntryID &name)=0
	Return details of a specific entry.
virtual unsigned long	rm (const IndexedIO::EntryID &name)=0
virtual void	write (const IndexedIO::EntryID &name, const float *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const double *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const half *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const int *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const int64_t *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const uint64_t *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const unsigned int *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const char *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const unsigned char *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const short *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const unsigned short *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const std::string *x, unsigned long arrayLength)=0
virtual void	write (const IndexedIO::EntryID &name, const float &x)=0
virtual void	write (const IndexedIO::EntryID &name, const double &x)=0
virtual void	write (const IndexedIO::EntryID &name, const half &x)=0
virtual void	write (const IndexedIO::EntryID &name, const int &x)=0
virtual void	write (const IndexedIO::EntryID &name, const int64_t &x)=0
virtual void	write (const IndexedIO::EntryID &name, const uint64_t &x)=0
virtual void	write (const IndexedIO::EntryID &name, const std::string &x)=0
virtual void	write (const IndexedIO::EntryID &name, const unsigned int &x)=0
virtual void	write (const IndexedIO::EntryID &name, const char &x)=0
virtual void	write (const IndexedIO::EntryID &name, const unsigned char &x)=0
virtual void	write (const IndexedIO::EntryID &name, const short &x)=0
virtual void	write (const IndexedIO::EntryID &name, const unsigned short &x)=0
virtual void	read (const IndexedIO::EntryID &name, float *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, double *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, half *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, int *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, int64_t *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, uint64_t *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, unsigned int *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, char *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, unsigned char *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, short *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, unsigned short *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, std::string *&x, unsigned long arrayLength)=0
virtual void	read (const IndexedIO::EntryID &name, float &x)=0
virtual void	read (const IndexedIO::EntryID &name, double &x)=0
virtual void	read (const IndexedIO::EntryID &name, half &x)=0
virtual void	read (const IndexedIO::EntryID &name, int &x)=0
virtual void	read (const IndexedIO::EntryID &name, int64_t &x)=0
virtual void	read (const IndexedIO::EntryID &name, uint64_t &x)=0
virtual void	read (const IndexedIO::EntryID &name, std::string &x)=0
virtual void	read (const IndexedIO::EntryID &name, unsigned int &x)=0
virtual void	read (const IndexedIO::EntryID &name, char &x)=0
virtual void	read (const IndexedIO::EntryID &name, unsigned char &x)=0
virtual void	read (const IndexedIO::EntryID &name, short &x)=0
virtual void	read (const IndexedIO::EntryID &name, unsigned short &x)=0
Static Public Member Functions
static IndexedIOInterfacePtr	create (const std::string &path, const IndexedIO::EntryID &root, IndexedIO::OpenMode mode)
static void	supportedExtensions (std::vector< std::string > &extensions)
Protected Member Functions
virtual void	readable (const IndexedIO::EntryID &name) const
virtual void	writable (const IndexedIO::EntryID &name) const
virtual void	validateOpenMode (IndexedIO::OpenMode &mode)

---

Detailed Description

Abstract interface to define operations on a random-access indexed input/output device. All methods throw an instance of IOException, or one of its subclasses, if an error is encountered.

---

Member Typedef Documentation

typedef IndexedIOInterfacePtr(* IECore::IndexedIOInterface::CreatorFn)(const std::string &, const IndexedIO::EntryID &, IndexedIO::OpenMode)

---

Constructor & Destructor Documentation

IndexedIOInterface::~IndexedIOInterface

(

)

[virtual]

---

Member Function Documentation

virtual void IECore::IndexedIOInterface::chdir

(

const IndexedIO::EntryID &

name

)

[pure 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.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

IndexedIOInterfacePtr IndexedIOInterface::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 in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

IECore::IndexedIOInterface::IE_CORE_DECLAREMEMBERPTR

(

IndexedIOInterface

)

virtual IndexedIO::Entry IECore::IndexedIOInterface::ls

(

const IndexedIO::EntryID &

name

)

[pure virtual]

Return details of a specific entry.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual IndexedIO::EntryList IECore::IndexedIOInterface::ls

(

IndexedIOFilterPtr

f = 0

)

[pure 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.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::mkdir

(

const IndexedIO::EntryID &

name

)

[pure virtual]

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

Parameters:

name

The directory to create.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual IndexedIO::OpenMode IECore::IndexedIOInterface::openMode

(

)

const [pure virtual]

Returns the mode with which the interface was created.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

Referenced by writable().

virtual IndexedIO::EntryID IECore::IndexedIOInterface::pwd

(

)

[pure virtual]

Retrieve the current directorys, relative to the root.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read an unsigned char from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a short from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read an unsigned char from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a char from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read an unsigned int from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a string from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a long from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a long from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read an int from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a half from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a double from an existing file

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Read a float from an existing file.

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		std::string *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		unsigned short *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		short *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		unsigned char *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		char *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		unsigned int *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		uint64_t *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		int64_t *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		int *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		half *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		double *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::read	(	const IndexedIO::EntryID &	name,
		float *&	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

void IndexedIOInterface::readable

(

const IndexedIO::EntryID &

name

)

const [protected, virtual]

Referenced by IECore::FileSystemIndexedIO::chdir(), IECore::FileIndexedIO::chdir(), IECore::FileIndexedIO::exists(), IECore::FileSystemIndexedIO::ls(), IECore::FileIndexedIO::ls(), IECore::FileSystemIndexedIO::pwd(), IECore::FileIndexedIO::pwd(), IECore::FileSystemIndexedIO::read(), and IECore::FileIndexedIO::read().

virtual IndexedIOInterfacePtr IECore::IndexedIOInterface::resetRoot

(

)

const [pure virtual]

Returns a new interface with the root set to the current directory.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual unsigned long IECore::IndexedIOInterface::rm

(

const IndexedIO::EntryID &

name

)

[pure 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.

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

void IndexedIOInterface::supportedExtensions

(

std::vector< std::string > &

extensions

)

[static]

Fills the passed vector with all the extensions for which an IndexedIOInterface implementation is available. Extensions are of the form "fio" - ie without a preceding '.'.

void IndexedIOInterface::validateOpenMode

(

IndexedIO::OpenMode &

mode

)

[protected, virtual]

References IECore::IndexedIO::Append, IECore::IndexedIO::Exclusive, IECore::IndexedIO::Read, IECore::IndexedIO::Shared, and IECore::IndexedIO::Write.

Referenced by IECore::FileIndexedIO::FileIndexedIO(), IECore::FileSystemIndexedIO::FileSystemIndexedIO(), and IECore::FileIndexedIO::open().

void IndexedIOInterface::writable

(

const IndexedIO::EntryID &

name

)

const [protected, virtual]

References IECore::IndexedIO::Append, openMode(), and IECore::IndexedIO::Write.

Referenced by IECore::FileIndexedIO::mkdir(), IECore::FileSystemIndexedIO::rm(), IECore::FileIndexedIO::rm(), IECore::FileSystemIndexedIO::write(), and IECore::FileIndexedIO::write().

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const unsigned short &	x
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified short

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const unsigned char &	x
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified char

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const unsigned int &	x
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified string

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified long

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified long

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified int

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified half

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified double

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

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

Create a new file containing the specified float

Parameters:

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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const std::string *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const unsigned short *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const short *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const unsigned char *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const char *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const unsigned int *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const uint64_t *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const int64_t *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const int *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const half *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const double *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

virtual void IECore::IndexedIOInterface::write	(	const IndexedIO::EntryID &	name,
		const float *	x,
		unsigned long	arrayLength
	)			[pure 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

Implemented in IECore::FileIndexedIO, and IECore::FileSystemIndexedIO.

---

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

• include/IECore/IndexedIOInterface.h
• src/IECore/IndexedIOInterface.cpp