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

#include <ISchema.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >:

Public Types

typedef INFO info_type
 
typedef ISchema< INFO > this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
typedef ICompoundProperty this_type
 

Public Member Functions

 ISchema ()
 
template<class CPROP_PTR >
 ISchema (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class CPROP_PTR >
 ISchema (CPROP_PTR iParentObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class CPROP_PTR >
 ISchema (CPROP_PTR iProperty, WrapExistingFlag iFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
virtual ~ISchema ()
 
template<class COMPOUND_PTR >
 ISchema (COMPOUND_PTR iProperty, WrapExistingFlag iFlag, const Argument &iArg0, const Argument &iArg1)
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty
 ICompoundProperty ()
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iParentProp, const std::string &iName, const Argument &iArg0=Argument())
 
template<class CPROP_PTR >
 ICompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 ICompoundProperty (OBJECT_PTR iThisObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ~ICompoundProperty ()
 
size_t getNumProperties () const
 Returns the number of properties contained in this ICompoundProperty. More...
 
const AbcA::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (const std::string &iName) const
 
ICompoundProperty getParent () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
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::CompoundPropertyReaderPtr 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 * getSchemaTitle ()
 
static const char * getDefaultSchemaName ()
 
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::CompoundPropertyReaderPtr >
typedef IBasePropertyT
< AbcA::CompoundPropertyReaderPtr
this_type
 
typedef IBasePropertyT
< AbcA::CompoundPropertyReaderPtr
operator_bool_base_type
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< AbcA::CompoundPropertyReaderPtr >
 IBasePropertyT ()
 
 IBasePropertyT (AbcA::CompoundPropertyReaderPtriPtr, 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::CompoundPropertyReaderPtr >
AbcA::CompoundPropertyReaderPtr m_property
 

Detailed Description

template<class INFO>
class Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >

See Schema Notes in OSchema.h ... Usually used as a base class, but could also theoretically be used as a standalone

Definition at line 57 of file ISchema.h.

Member Typedef Documentation

template<class INFO>
typedef INFO Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::info_type

Definition at line 63 of file ISchema.h.

template<class INFO>
typedef ISchema<INFO> Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::this_type

Definition at line 64 of file ISchema.h.

Constructor & Destructor Documentation

template<class INFO>
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::ISchema ( )
inline

The default constructor creates an empty ISchema function set.

Definition at line 112 of file ISchema.h.

template<class INFO>
template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::ISchema ( CPROP_PTR  iParentObject,
const std::string iName,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)
inline

Creates a new Compound Property Reader with the schema information added to the metadata. arguments count include error handling, strictness matching.

Definition at line 118 of file ISchema.h.

template<class INFO>
template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::ISchema ( CPROP_PTR  iParentObject,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)
inlineexplicit

Creates a new Compound Property Reader with the schema information and also the default name.

Definition at line 130 of file ISchema.h.

template<class INFO>
template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::ISchema ( CPROP_PTR  iProperty,
WrapExistingFlag  iFlag,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)

Wrap an existing compound property, checking that it matches the schema title info, if strict matching has been selected. Arguments allow selection of error handling and matching strictness

template<class INFO>
virtual Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::~ISchema ( )
inlinevirtual

Default copy constructor used Default assignment operator used.

Definition at line 152 of file ISchema.h.

template<class INFO>
template<class COMPOUND_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::ISchema ( COMPOUND_PTR  iProperty,
WrapExistingFlag  iFlag,
const Argument iArg0,
const Argument iArg1 
)
inline

Definition at line 209 of file ISchema.h.

Member Function Documentation

template<class INFO>
static const char* Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::getDefaultSchemaName ( )
inlinestatic

Return the default name for instances of this schema. Often something like ".geom"

Definition at line 75 of file ISchema.h.

template<class INFO>
static const char* Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::getSchemaTitle ( )
inlinestatic

Return the schema title expected of this property. An empty title matches everything

Definition at line 68 of file ISchema.h.

template<class INFO>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::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 83 of file ISchema.h.

template<class INFO>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::ISchema< INFO >::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, as well as the data type.

Definition at line 100 of file ISchema.h.


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