All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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

bool valid () const
 Test validity. More...
const std::stringerror () const
 Error (set on creation) More...
const std::vector< std::string > & filenames () 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 object references. More...
void reopenStream (int num_ogawa_streams=-1)
void incref ()
void decref ()

Static Public Member Functions

static std::string filenamesToString (const std::vector< std::string > &filenames)


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 58 of file GABC_IArchive.h.

Member Typedef Documentation

Member Function Documentation

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

Access to the underlying archive.

Definition at line 79 of file GABC_IArchive.h.

void GABC_NAMESPACE::GABC_IArchive::decref ( )

Reference counting

Definition at line 103 of file GABC_IArchive.h.

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

Error (set on creation)

Definition at line 70 of file GABC_IArchive.h.

const std::vector<std::string>& GABC_NAMESPACE::GABC_IArchive::filenames ( ) const

Access the filename.

Definition at line 73 of file GABC_IArchive.h.

static std::string GABC_NAMESPACE::GABC_IArchive::filenamesToString ( const std::vector< std::string > &  filenames)

Generate a single, user-friendly printable string from a list of filenames

GABC_IObject GABC_NAMESPACE::GABC_IArchive::getTop ( ) const

Get the root object.

void GABC_NAMESPACE::GABC_IArchive::incref ( )

Reference counting

Definition at line 102 of file GABC_IArchive.h.

bool GABC_NAMESPACE::GABC_IArchive::isOgawa ( ) const

Definition at line 81 of file GABC_IArchive.h.

void GABC_NAMESPACE::GABC_IArchive::purgeObjects ( )

Purge all object 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

Test validity.

Definition at line 67 of file GABC_IArchive.h.

Friends And Related Function Documentation

friend class GABC_AutoLock

Definition at line 131 of file GABC_IArchive.h.

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