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

#include <ICompoundProperty.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty:

Public Types

typedef ICompoundProperty this_type
 

Public Member Functions

 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
 

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

Definition at line 51 of file ICompoundProperty.h.

Member Typedef Documentation

By convention we always define this_type in Abc classes Used by unspecified-bool-type conversion below

Definition at line 57 of file ICompoundProperty.h.

Constructor & Destructor Documentation

Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::ICompoundProperty ( )
inline

The default constructor creates an empty ICompoundProperty function set. ...

Definition at line 65 of file ICompoundProperty.h.

template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::ICompoundProperty ( CPROP_PTR  iParentProp,
const std::string iName,
const Argument iArg0 = Argument() 
)
inline

This templated, explicit function creates a new compound property reader. The first argument is any Abc (or AbcCoreAbstract) object which can intrusively be converted to an 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

Definition at line 156 of file ICompoundProperty.h.

template<class CPROP_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::ICompoundProperty ( CPROP_PTR  iThisObject,
WrapExistingFlag  iWrap,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)
inline

This attaches an ICompoundProperty wrapper around an existing CompoundPropertyReaderPtr, with an optional error handling policy.

The extra argument is to support ISchema, which is publicly derived from ICompoundProperty (see ISchema.h).

Definition at line 169 of file ICompoundProperty.h.

template<class OBJECT_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::ICompoundProperty ( OBJECT_PTR  iThisObject,
TopFlag  ,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)
inline

This attaches an ICompoundProperty wrapper around the top properties of any object, with an optional error handling policy.

The extra argument is to support ISchema, which is publicly derived from ICompoundProperty (see ISchema.h).

Definition at line 183 of file ICompoundProperty.h.

Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::~ICompoundProperty ( )

Default copy constructor used Default assignment operator used. Destructor ...

Member Function Documentation

size_t Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::getNumProperties ( ) const

Returns the number of properties contained in this ICompoundProperty.

ICompoundProperty Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::getParent ( ) const

There is no distinction between already added properties and created properties with an AbcA::CompoundPropertyReader, therefore we have no need to expose "getProperty". Simply use the appropriate IScalarProperty, ICompoundProperty, or IArrayProperty wrappers. Return the parent compound property, handily wrapped in a ICompoundProperty wrapper.

const AbcA::PropertyHeader& Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::getPropertyHeader ( size_t  i) const

Return the header of a child property. Property is selected by index. This will throw an exception on out-of-range access.

const AbcA::PropertyHeader* Alembic::Abc::ALEMBIC_VERSION_NS::ICompoundProperty::getPropertyHeader ( const std::string iName) const

Return the header of a property name. This will return a NULL pointer if no header by that name is found.


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