Cortex  10.0.0-a4
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
IECore::IndexedIO::Entry Class Reference

A representation of a single file/directory. More...

#include <IndexedIO.h>

Public Member Functions

 Entry (const EntryID &id, EntryType eType, DataType dType, unsigned long arrayLength)
 
const EntryIDid () const
 ID, or name, of the file/directory.
 
EntryType entryType () const
 Returns either Directory or File.
 
DataType dataType () const
 
bool isArray () const
 Convenience method to return if entry respresents an array. If Entry's datatype is not an array then an IOException is thrown.
 
unsigned long arrayLength () const
 Convenience method to return size of array. If Entry's datatype is not an array then an IOException is thrown.
 

Static Public Member Functions

static bool isArray (DataType dType)
 Convenience method to return if a data is an array or not.
 

Protected Attributes

EntryID m_ID
 
EntryType m_entryType
 
DataType m_dataType
 
unsigned long m_arrayLength
 

Detailed Description

A representation of a single file/directory.

Member Function Documentation

DataType IECore::IndexedIO::Entry::dataType ( ) const

Should only be called on instances which represent files. Returns the type of data held by in the file. If this entry does not represent a file an IOException is thrown.


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