Alembic::Abc::ALEMBIC_VERSION_NS::IArchive Class Reference
#include <IArchive.h>
Public Types | |
| typedef IArchive | this_type |
Public Member Functions | |
| IArchive () | |
| template<class ARCHIVE_CTOR > | |
| IArchive (ARCHIVE_CTOR iCtor, const std::string &iFileName, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy, AbcA::ReadArraySampleCachePtr iCachePtr=AbcA::ReadArraySampleCachePtr()) | |
| IArchive (AbcA::ArchiveReaderPtr iPtr, WrapExistingFlag iWrap, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy) | |
| ~IArchive () | |
| std::string | getName () const |
| IObject | getTop () |
| AbcA::ReadArraySampleCachePtr | getReadArraySampleCachePtr () |
| void | setReadArraySampleCachePtr (AbcA::ReadArraySampleCachePtr iPtr) |
| AbcA::ArchiveReaderPtr | getPtr () |
| void | reset () |
| AbcA::TimeSamplingPtr | getTimeSampling (uint32_t iIndex) |
| Returns the TimeSampling at a given index. | |
| uint32_t | getNumTimeSamplings () |
| bool | valid () const |
| int32_t | getArchiveVersion () |
| ALEMBIC_OPERATOR_BOOL (valid()) | |
Detailed Description
Definition at line 51 of file IArchive.h.
Member Typedef Documentation
By convention, we always define "this_type" in every Abc class. This convention is relied upon by the unspecified-bool-type cast
Definition at line 57 of file IArchive.h.
Constructor & Destructor Documentation
| Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::IArchive | ( | ) | [inline] |
The default constructor creates an empty IArchive function set. ...
Definition at line 65 of file IArchive.h.
| Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::IArchive | ( | ARCHIVE_CTOR | iCtor, | |
| const std::string & | iFileName, | |||
| ErrorHandler::Policy | iPolicy = ErrorHandler::kThrowPolicy, |
|||
| AbcA::ReadArraySampleCachePtr | iCachePtr = AbcA::ReadArraySampleCachePtr() | |||
| ) | [inline] |
The explicit constructor opens an existing archive with the given file name. Additional arguments that may be passed are the error handler policy and a pointer to a cache instance. By default, an archive-local cache will be created.
- Parameters:
-
iCtor We need to pass in a constructor which provides an explicit link to the concrete implementation of AbcCoreAbstract that we're using. iFileName The file name.
Definition at line 184 of file IArchive.h.
| Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::IArchive | ( | AbcA::ArchiveReaderPtr | iPtr, | |
| WrapExistingFlag | iWrap, | |||
| ErrorHandler::Policy | iPolicy = ErrorHandler::kThrowPolicy | |||
| ) | [inline] |
This attaches an IArchive wrapper around an existing ArchiveReaderPtr, with an optional error handling policy.
- Parameters:
-
iPtr The pointer ... iWrap Wrap existing ... iPolicy Optional error handling policy ...
Definition at line 86 of file IArchive.h.
| Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::~IArchive | ( | ) |
Destructor ...
Member Function Documentation
| Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::ALEMBIC_OPERATOR_BOOL | ( | valid() | ) |
The unspecified-bool-type operator casts the object to "true" if it is valid, and "false" otherwise.
| int32_t Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::getArchiveVersion | ( | ) |
Returns the Alembic library numeric version (see Foundation.h) of this archive file.
| std::string Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::getName | ( | ) | const |
Default copy constructor Default assignment operator Returns the file name. It is an error to do so with an invalid object.
| uint32_t Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::getNumTimeSamplings | ( | ) |
Returns the total number of TimeSamplingPtrs in the Archive TimeSampling pool.
| AbcA::ArchiveReaderPtr Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::getPtr | ( | ) | [inline] |
getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the ArchiveReaderPtr.
Definition at line 143 of file IArchive.h.
| AbcA::ReadArraySampleCachePtr Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::getReadArraySampleCachePtr | ( | ) |
Get the read array sample cache. It may be a NULL pointer. Caches can be shared amongst separate archives, and caching will is disabled if a NULL cache is returned here.
| AbcA::TimeSamplingPtr Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::getTimeSampling | ( | uint32_t | iIndex | ) |
Returns the TimeSampling at a given index.
| IObject Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::getTop | ( | ) |
This returns the single top-level IObject that exists automatically as part of the archive.
| void Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::reset | ( | ) | [inline] |
Reset returns this function et to an empty, default state.
Reimplemented from Alembic::Abc::ALEMBIC_VERSION_NS::Base.
Definition at line 147 of file IArchive.h.
| void Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::setReadArraySampleCachePtr | ( | AbcA::ReadArraySampleCachePtr | iPtr | ) |
Set the read array sample cache. It may also be a NULL pointer. Caches can be shared amongst separate archives, and caching will be disabled if a NULL cache is passed here.
| bool Alembic::Abc::ALEMBIC_VERSION_NS::IArchive::valid | ( | ) | const [inline] |
Valid returns whether this function set is valid.
Reimplemented from Alembic::Abc::ALEMBIC_VERSION_NS::Base.
Definition at line 158 of file IArchive.h.
The documentation for this class was generated from the following file:
- Alembic/Abc/IArchive.h
