Cortex  10.0.0-a4
Public Member Functions | List of all members
IECore::Object::LoadContext Class Reference

The class provided to the load() method implemented by subclasses. More...

#include <Object.h>

+ Inheritance diagram for IECore::Object::LoadContext:

Public Member Functions

 LoadContext (ConstIndexedIOPtr ioInterface)
 
ConstIndexedIOPtr container (const std::string &typeName, unsigned int &ioVersion, bool throwIfMissing=true)
 
template<class T >
T::Ptr load (const IndexedIO *container, const IndexedIO::EntryID &name)
 Load an Object instance previously saved by SaveContext::save().
 
const IndexedIOrawContainer ()
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 

Additional Inherited Members

- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 

Detailed Description

The class provided to the load() method implemented by subclasses.

Member Function Documentation

ConstIndexedIOPtr IECore::Object::LoadContext::container ( const std::string &  typeName,
unsigned int &  ioVersion,
bool  throwIfMissing = true 
)

Returns an interface to the container created by SaveContext::container().

Parameters
typeNameThe typename of your class.
ioVersionOn entry this should contain the current file format version for your class. On exit it will contain the file format version of the file being read. If the latter is greater than the former an exception is thrown (the file is newer than the library) - this should not be caught.
throwIfMissingIf false will and the container does not carry the entry for the type name, returns a null pointer.
const IndexedIO* IECore::Object::LoadContext::rawContainer ( )

Returns an interface to a raw container created by SaveContext::rawContainer() - please see documentation and cautionary notes for that function.


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