HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS > Class Template Reference

#include <ITypedArrayProperty.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >:

Public Types

typedef TRAITS traits_type
 
typedef ITypedArrayProperty
< TRAITS > 
this_type
 
typedef TRAITS::value_type value_type
 
typedef TypedArraySample< TRAITS > sample_type
 
typedef shared_ptr< sample_typesample_ptr_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty
typedef IArrayProperty this_type
 

Public Member Functions

 ITypedArrayProperty ()
 
template<class COMPOUND_PTR >
 ITypedArrayProperty (COMPOUND_PTR iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ITypedArrayProperty (AbcA::ArrayPropertyReaderPtr iProp, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
void get (sample_ptr_type &iVal, const ISampleSelector &iSS=ISampleSelector()) const
 
sample_ptr_type getValue (const ISampleSelector &iSS=ISampleSelector()) const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IArrayProperty
 IArrayProperty ()
 
template<class OBJECT_PTR >
 IArrayProperty (OBJECT_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 IArrayProperty (AbcA::ArrayPropertyReaderPtr iPtr, WrapExistingFlag iWrapFlag, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy)
 
 ~IArrayProperty ()
 
size_t getNumSamples () const
 
bool isConstant () const
 
bool isScalarLike () const
 Ask if we are like a scalar - we have 1 and only 1 DataType per sample. More...
 
AbcA::TimeSamplingPtr getTimeSampling () const
 Time information. More...
 
void get (AbcA::ArraySamplePtr &oSample, const ISampleSelector &iSS=ISampleSelector()) const
 
void getAs (void *oSample, AbcA::PlainOldDataType iPod, const ISampleSelector &iSS=ISampleSelector())
 Get a sample into the address of a datum as a particular POD type. More...
 
void getAs (void *oSample, const ISampleSelector &iSS=ISampleSelector())
 
bool getKey (AbcA::ArraySampleKey &oKey, const ISampleSelector &iSS=ISampleSelector()) const
 
void getDimensions (Util::Dimensions &oDim, const ISampleSelector &iSS=ISampleSelector()) const
 Get the dimensions of the datum. More...
 
ICompoundProperty getParent () const
 
template<class CPROP_PTR >
 IArrayProperty (CPROP_PTR iParentProp, const std::string &iName, const Argument &iArg0, const Argument &iArg1)
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
const AbcA::PropertyHeadergetHeader () const
 
const std::stringgetName () const
 
AbcA::PropertyType getPropertyType () const
 
bool isScalar () const
 
bool isArray () const
 
bool isCompound () const
 
bool isSimple () const
 
const AbcA::MetaDatagetMetaData () const
 
const AbcA::DataTypegetDataType () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
IObject getObject () const
 
AbcA::ArrayPropertyReaderPtr getPtr () const
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OPERATOR_BOOL (valid())
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
ErrorHandlergetErrorHandler () const
 
ErrorHandler::Policy getErrorHandlerPolicy () const
 

Static Public Member Functions

static const char * getInterpretation ()
 
static bool matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
 
static bool matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
 

Additional Inherited Members

- Protected Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
typedef IBasePropertyT
< AbcA::ArrayPropertyReaderPtr
this_type
 
typedef IBasePropertyT
< AbcA::ArrayPropertyReaderPtr
operator_bool_base_type
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
 IBasePropertyT ()
 
 IBasePropertyT (AbcA::ArrayPropertyReaderPtriPtr, WrapExistingFlag iWrapFlag, ErrorHandler::Policy iPolicy)
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
 Base ()
 
 Base (ErrorHandler::Policy iPolicy)
 
 Base (const Base &iCopy)
 
Baseoperator= (const Base &iCopy)
 
bool valid () const
 
void reset ()
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::ArrayPropertyReaderPtr >
AbcA::ArrayPropertyReaderPtr m_property
 

Detailed Description

template<class TRAITS>
class Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >

Definition at line 50 of file ITypedArrayProperty.h.

Member Typedef Documentation

template<class TRAITS>
typedef shared_ptr<sample_type> Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::sample_ptr_type

Definition at line 60 of file ITypedArrayProperty.h.

template<class TRAITS>
typedef TypedArraySample<TRAITS> Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::sample_type

Definition at line 59 of file ITypedArrayProperty.h.

template<class TRAITS>
typedef ITypedArrayProperty<TRAITS> Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::this_type

Definition at line 57 of file ITypedArrayProperty.h.

template<class TRAITS>
typedef TRAITS Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::traits_type

Definition at line 56 of file ITypedArrayProperty.h.

template<class TRAITS>
typedef TRAITS::value_type Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::value_type

Definition at line 58 of file ITypedArrayProperty.h.

Constructor & Destructor Documentation

template<class TRAITS>
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::ITypedArrayProperty ( )
inline

Default constructor ...

Definition at line 104 of file ITypedArrayProperty.h.

template<class TRAITS >
template<class COMPOUND_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::ITypedArrayProperty ( COMPOUND_PTR  iParent,
const std::string iName,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)

This templated, explicit function creates a new typed array property reader. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to a CompoundPropertyReaderPtr to use as a parent, from which the error handler policy for inheritance is also derived. The remaining optional arguments can be used to override the ErrorHandlerPolicy, to specify schema matching policy, and that's it.

Definition at line 163 of file ITypedArrayProperty.h.

Explicitly wrap an existing property It will check the data type and also verify the schema, if requested.

Definition at line 207 of file ITypedArrayProperty.h.

Member Function Documentation

template<class TRAITS>
void Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::get ( sample_ptr_type iVal,
const ISampleSelector iSS = ISampleSelector() 
) const
inline

Get the typed sample. ...

Definition at line 136 of file ITypedArrayProperty.h.

template<class TRAITS>
static const char* Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::getInterpretation ( )
inlinestatic

Return the interpretation expected of this property. An empty interpretation matches everything

Definition at line 64 of file ITypedArrayProperty.h.

template<class TRAITS>
sample_ptr_type Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::getValue ( const ISampleSelector iSS = ISampleSelector()) const
inline

Return the typed sample by value. ...

Definition at line 147 of file ITypedArrayProperty.h.

template<class TRAITS>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::matches ( const AbcA::MetaData iMetaData,
SchemaInterpMatching  iMatching = kStrictMatching 
)
inlinestatic

This will check whether or not a given entity (as represented by a metadata) strictly matches the interpretation of this schema object

Definition at line 72 of file ITypedArrayProperty.h.

template<class TRAITS>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< TRAITS >::matches ( const AbcA::PropertyHeader iHeader,
SchemaInterpMatching  iMatching = kStrictMatching 
)
inlinestatic

This will check whether or not a given object (as represented by an object header) strictly matches the interpretation of this schema object

Definition at line 86 of file ITypedArrayProperty.h.


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