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::string &	error () 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 IArchive &	archive () const
	Access to the underlying archive. More...
Alembic::Abc::MetaData	getMetadata ()
	Access to archive metadata. 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)

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

Member Typedef Documentation

using GABC_NAMESPACE::GABC_IArchive::gabc_istream = FS_IStreamDevice

Definition at line 61 of file GABC_IArchive.h.

using GABC_NAMESPACE::GABC_IArchive::gabc_streambuf = FS_IStreamDeviceBuffer

Definition at line 62 of file GABC_IArchive.h.

using GABC_NAMESPACE::GABC_IArchive::IArchive = Alembic::Abc::IArchive

Definition at line 63 of file GABC_IArchive.h.

using GABC_NAMESPACE::GABC_IArchive::SetType = UT_Set<GABC_IItem *>

Definition at line 64 of file GABC_IArchive.h.

Member Function Documentation

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

inline

Access to the underlying archive.

Definition at line 79 of file GABC_IArchive.h.

void GABC_NAMESPACE::GABC_IArchive::decref ( )

inline

Reference counting

Definition at line 109 of file GABC_IArchive.h.

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

inline

Error (set on creation)

Definition at line 70 of file GABC_IArchive.h.

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

inline

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 )

static

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

Alembic::Abc::MetaData GABC_NAMESPACE::GABC_IArchive::getMetadata ( )

inline

Access to archive metadata.

Definition at line 82 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 108 of file GABC_IArchive.h.

bool GABC_NAMESPACE::GABC_IArchive::isOgawa ( ) const

inline

Definition at line 87 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

inline

Test validity.

Definition at line 67 of file GABC_IArchive.h.

Friends And Related Function Documentation

friend class GABC_AutoLock

friend

Definition at line 137 of file GABC_IArchive.h.

---

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

• GABC/GABC_IArchive.h