HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory Class Reference

#include <IFactory.h>

Public Types

enum  CoreType { kHDF5, kOgawa, kUnknown }
 The type which yielded a valid IArchive (or kUnknown if invalid) More...
 

Public Member Functions

 IFactory ()
 
 ~IFactory ()
 
Alembic::Abc::IArchive getArchive (const std::string &iFileName, CoreType &oType)
 
Alembic::Abc::IArchive getArchive (const std::string &iFileName)
 
Alembic::Abc::IArchive getArchive (const std::vector< std::istream * > &iStreams, CoreType &oType)
 
void setHDF5CacheHierarchy (bool iCacheHierarchy)
 
bool getHDF5CacheHierarchy () const
 Gets whether an HDF5 file will use the cached hierarchy. More...
 
void setSampleCache (Alembic::AbcCoreAbstract::ReadArraySampleCachePtr iCachePtr)
 Set the array sample cache, the HDF5 implementation optionally uses this. More...
 
Alembic::AbcCoreAbstract::ReadArraySampleCachePtr getSampleCache () const
 Get the array sample cache. More...
 
size_t getOgawaNumStreams () const
 
void setOgawaNumStreams (size_t iNumStreams)
 
Alembic::Abc::ErrorHandler::Policy getPolicy ()
 Gets the error handler policy. More...
 
void setPolicy (Alembic::Abc::ErrorHandler::Policy iPolicy)
 Sets the error handler policy, the default is kThrowPolicy. More...
 

Detailed Description

Definition at line 48 of file IFactory.h.

Member Enumeration Documentation

The type which yielded a valid IArchive (or kUnknown if invalid)

Enumerator
kHDF5 
kOgawa 
kUnknown 

Definition at line 55 of file IFactory.h.

Constructor & Destructor Documentation

Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::IFactory ( )
Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::~IFactory ( )

Member Function Documentation

Alembic::Abc::IArchive Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::getArchive ( const std::string iFileName,
CoreType oType 
)

Try to open a file and set oType to the one that yields a successful oType, or kUnknown if the IArchive isn't valid

Alembic::Abc::IArchive Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::getArchive ( const std::string iFileName)

Try to open a file and return IArchive. If the file wasn't a valid file or known type and invalid archive is returned.

Alembic::Abc::IArchive Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::getArchive ( const std::vector< std::istream * > &  iStreams,
CoreType oType 
)

Use the streams (Alembic does not take ownership) to read the data from This is currently only valid for Ogawa. The streams must all reference the same data.

bool Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::getHDF5CacheHierarchy ( ) const
inline

Gets whether an HDF5 file will use the cached hierarchy.

Definition at line 85 of file IFactory.h.

size_t Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::getOgawaNumStreams ( ) const
inline

Gets the number of streams that will be opened when opening an Ogawa file

Definition at line 102 of file IFactory.h.

Alembic::Abc::ErrorHandler::Policy Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::getPolicy ( )
inline

Gets the error handler policy.

Definition at line 112 of file IFactory.h.

Alembic::AbcCoreAbstract::ReadArraySampleCachePtr Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::getSampleCache ( ) const
inline

Get the array sample cache.

Definition at line 95 of file IFactory.h.

void Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::setHDF5CacheHierarchy ( bool  iCacheHierarchy)
inline

If opening an HDF5 file, sets whether to use the cached hierarchy if it exists, the default value is true

Definition at line 79 of file IFactory.h.

void Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::setOgawaNumStreams ( size_t  iNumStreams)
inline

Sets the number of streams that will be opened when opening an Ogawa file, the default is 1

Definition at line 106 of file IFactory.h.

void Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::setPolicy ( Alembic::Abc::ErrorHandler::Policy  iPolicy)
inline

Sets the error handler policy, the default is kThrowPolicy.

Definition at line 115 of file IFactory.h.

void Alembic::AbcCoreFactory::ALEMBIC_VERSION_NS::IFactory::setSampleCache ( Alembic::AbcCoreAbstract::ReadArraySampleCachePtr  iCachePtr)
inline

Set the array sample cache, the HDF5 implementation optionally uses this.

Definition at line 88 of file IFactory.h.


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