HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema Class Reference

#include <OCollections.h>

+ Inheritance diagram for Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema:

Public Types

typedef OCollectionsSchema this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< CollectionsSchemaInfo >
typedef CollectionsSchemaInfo info_type
 
typedef OSchema
< CollectionsSchemaInfo > 
this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
typedef OCompoundProperty this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
typedef OBasePropertyT
< AbcA::CompoundPropertyWriterPtr
this_type
 
typedef OBasePropertyT
< AbcA::CompoundPropertyWriterPtr
operator_bool_base_type
 

Public Member Functions

 OCollectionsSchema ()
 
template<class CPROP_PTR >
 OCollectionsSchema (CPROP_PTR iParent, const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
 
template<class CPROP_PTR >
 OCollectionsSchema (CPROP_PTR iParent, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
 
 OCollectionsSchema (const OCollectionsSchema &iCopy)
 Copy constructor. More...
 
Abc::OStringArrayProperty createCollection (const std::string &iName, const Abc::Argument &iArg0=Abc::Argument(), const Abc::Argument &iArg1=Abc::Argument(), const Abc::Argument &iArg2=Abc::Argument())
 
size_t getNumCollections ()
 Returns the number of collections that we have. More...
 
Abc::OStringArrayProperty getCollection (size_t i)
 Return a collection by index. More...
 
Abc::OStringArrayProperty getCollection (const std::string &iName)
 Return a collection by name. More...
 
bool valid () const
 Returns whether this function set is valid. More...
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< CollectionsSchemaInfo >
 OSchema ()
 
 OSchema (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OSchema (CPROP_PTR iParentObject, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
virtual ~OSchema ()
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty
 OCompoundProperty ()
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iParentObject, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class CPROP_PTR >
 OCompoundProperty (CPROP_PTR iThisObject, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
template<class OBJECT_PTR >
 OCompoundProperty (OBJECT_PTR iObject, TopFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
 ~OCompoundProperty ()
 
size_t getNumProperties () const
 
const AbcA::PropertyHeadergetPropertyHeader (size_t i) const
 
const AbcA::PropertyHeadergetPropertyHeader (const std::string &iName) const
 
OBaseProperty getProperty (size_t i) const
 
OBaseProperty getProperty (const std::string &iName) const
 
OCompoundProperty getParent () const
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
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
 
OObject getObject () const
 
AbcA::CompoundPropertyWriterPtr 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
 

Protected Attributes

std::vector
< Abc::OStringArrayProperty
m_collections
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
AbcA::CompoundPropertyWriterPtr m_property
 

Additional Inherited Members

- Static Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< CollectionsSchemaInfo >
static const char * getSchemaTitle ()
 
static const char * getSchemaBaseType ()
 
static const char * getDefaultSchemaName ()
 
static bool matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
 
static bool matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
 OBasePropertyT ()
 
 OBasePropertyT (AbcA::CompoundPropertyWriterPtriPtr, WrapExistingFlag, 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 ()
 

Detailed Description

Definition at line 48 of file OCollections.h.

Member Typedef Documentation

Constructor & Destructor Documentation

Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema ( )
inline

Definition at line 55 of file OCollections.h.

template<class CPROP_PTR >
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema ( CPROP_PTR  iParent,
const std::string iName,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument(),
const Abc::Argument iArg2 = Abc::Argument() 
)
inline

Definition at line 58 of file OCollections.h.

template<class CPROP_PTR >
Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema ( CPROP_PTR  iParent,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument(),
const Abc::Argument iArg2 = Abc::Argument() 
)
inlineexplicit

Definition at line 69 of file OCollections.h.

Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::OCollectionsSchema ( const OCollectionsSchema iCopy)
inline

Copy constructor.

Definition at line 79 of file OCollections.h.

Member Function Documentation

Abc::OStringArrayProperty Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::createCollection ( const std::string iName,
const Abc::Argument iArg0 = Abc::Argument(),
const Abc::Argument iArg1 = Abc::Argument(),
const Abc::Argument iArg2 = Abc::Argument() 
)

Create a named collection, if the collection already exists return it.

Abc::OStringArrayProperty Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::getCollection ( size_t  i)

Return a collection by index.

Abc::OStringArrayProperty Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::getCollection ( const std::string iName)

Return a collection by name.

size_t Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::getNumCollections ( )
inline

Returns the number of collections that we have.

Definition at line 94 of file OCollections.h.

bool Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::valid ( ) const
inline

Returns whether this function set is valid.

Definition at line 103 of file OCollections.h.

Member Data Documentation

std::vector< Abc::OStringArrayProperty > Alembic::AbcCollection::ALEMBIC_VERSION_NS::OCollectionsSchema::m_collections
protected

Definition at line 109 of file OCollections.h.


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