HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GABC_NAMESPACE::GABC_IArchive Class Reference

#include <GABC_IArchive.h>

Public Types

using gabc_istream = FS_IStreamDevice
 
using gabc_streambuf = FS_IStreamDeviceBuffer
 
using IArchive = Alembic::Abc::IArchive
 
using SetType = UT_Set< GABC_IItem * >
 

Public Member Functions

 ~GABC_IArchive ()
 Destructor. More...
 
bool valid () const
 Test validity. More...
 
bool purged () const
 Check to see if the archive has been purged (invalid) More...
 
const std::stringerror () const
 Error (set on creation) More...
 
const std::stringfilename () const
 Access the filename. More...
 
GABC_IObject getTop () const
 Get the root object. More...
 
const IArchivearchive () const
 Access to the underlying archive. More...
 
bool isOgawa () const
 
void purgeObjects ()
 Purge all objects references. More...
 
void reopenStream (int num_ogawa_streams=-1)
 
void incref ()
 
void decref ()
 

Friends

class GABC_AutoLock
 
void reference (GABC_IItem *item)
 Called to maintain references to GABC_IItem objects. More...
 
void unreference (GABC_IItem *item)
 Called to maintain references to GABC_IItem objects. More...
 

Detailed Description

Wrapper around an Alembic archive. This provides thread-safe access to Alembic data.

Definition at line 59 of file GABC_IArchive.h.

Member Typedef Documentation

Constructor & Destructor Documentation

GABC_NAMESPACE::GABC_IArchive::~GABC_IArchive ( )

Destructor.

Member Function Documentation

const IArchive& GABC_NAMESPACE::GABC_IArchive::archive ( ) const
inline

Access to the underlying archive.

Definition at line 86 of file GABC_IArchive.h.

void GABC_NAMESPACE::GABC_IArchive::decref ( )
inline

Reference counting

Definition at line 110 of file GABC_IArchive.h.

const std::string& GABC_NAMESPACE::GABC_IArchive::error ( ) const
inline

Error (set on creation)

Definition at line 77 of file GABC_IArchive.h.

const std::string& GABC_NAMESPACE::GABC_IArchive::filename ( ) const
inline

Access the filename.

Definition at line 80 of file GABC_IArchive.h.

GABC_IObject GABC_NAMESPACE::GABC_IArchive::getTop ( ) const

Get the root object.

void GABC_NAMESPACE::GABC_IArchive::incref ( )
inline

Reference counting

Definition at line 109 of file GABC_IArchive.h.

bool GABC_NAMESPACE::GABC_IArchive::isOgawa ( ) const
inline

Definition at line 88 of file GABC_IArchive.h.

bool GABC_NAMESPACE::GABC_IArchive::purged ( ) const
inline

Check to see if the archive has been purged (invalid)

Definition at line 74 of file GABC_IArchive.h.

void GABC_NAMESPACE::GABC_IArchive::purgeObjects ( )

Purge all objects references.

void GABC_NAMESPACE::GABC_IArchive::reference ( GABC_IItem item)

Called to maintain references to GABC_IItem objects.

void GABC_NAMESPACE::GABC_IArchive::reopenStream ( int  num_ogawa_streams = -1)

Close and reopen the archive with the given number of file streams (-1 is to use the default)

void GABC_NAMESPACE::GABC_IArchive::unreference ( GABC_IItem item)

Called to maintain references to GABC_IItem objects.

bool GABC_NAMESPACE::GABC_IArchive::valid ( ) const
inline

Test validity.

Definition at line 71 of file GABC_IArchive.h.

Friends And Related Function Documentation

friend class GABC_AutoLock
friend

Definition at line 132 of file GABC_IArchive.h.


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