All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID Class Reference

#include <ReadArraySampleCache.h>

Public Types

typedef ReadArraySampleID this_type

Public Member Functions

 ReadArraySampleID ()
 ReadArraySampleID (const ArraySample::Key &iSampleKey, ArraySamplePtr iSample)
 Explicit constructor creates ID with key and sample. More...
const ArraySample::KeygetKey () const
ArraySamplePtr getSample () const
bool valid () const

Detailed Description

A ReadArraySampleID is a bundle that contains a pointer to the ArraySample itself, along with the sample's key.

Definition at line 51 of file ReadArraySampleCache.h.

Member Typedef Documentation

By convention, we define the typedef this_type. This is used by the unspecified-bool-type cast below.

Definition at line 56 of file ReadArraySampleCache.h.

Constructor & Destructor Documentation

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::ReadArraySampleID ( )

Default constructor creates empty ID ...

Definition at line 60 of file ReadArraySampleCache.h.

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::ReadArraySampleID ( const ArraySample::Key iSampleKey,
ArraySamplePtr  iSample 

Explicit constructor creates ID with key and sample.

Definition at line 63 of file ReadArraySampleCache.h.

Member Function Documentation

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::ALEMBIC_OPERATOR_BOOL ( valid()  )

Unspecified bool type cast ...

const ArraySample::Key& Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::getKey ( ) const

Default copy constructor Default assignment operator. Return the sample key ...

Definition at line 73 of file ReadArraySampleCache.h.

ArraySamplePtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::getSample ( ) const

Return the sample itself. ...

Definition at line 78 of file ReadArraySampleCache.h.

bool Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleID::valid ( ) const

Return whether or not this read sample is valid ...

Definition at line 83 of file ReadArraySampleCache.h.

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