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

#include <OCompoundProperty.h>

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

Public Types

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

 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
 

Additional Inherited Members

- 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 ()
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::CompoundPropertyWriterPtr >
AbcA::CompoundPropertyWriterPtr m_property
 

Detailed Description

Definition at line 51 of file OCompoundProperty.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 OCompoundProperty.h.

Constructor & Destructor Documentation

Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty ( )
inline

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

Definition at line 65 of file OCompoundProperty.h.

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

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

Definition at line 161 of file OCompoundProperty.h.

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

This attaches an OCompoundProperty wrapper around an existing CompoundPropertyWriterPtr, with an optional error handling policy.

Definition at line 175 of file OCompoundProperty.h.

template<class OBJECT_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::OCompoundProperty ( OBJECT_PTR  iObject,
TopFlag  iTop,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)
inline

This attaches an OCompoundProperty wrapper around the top properties of an OObject.

Definition at line 189 of file OCompoundProperty.h.

Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::~OCompoundProperty ( )

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

Member Function Documentation

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

Returns the number of properties that have been created thus far. May change as more are created.

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

Return the parent compound property, handily wrapped in a OCompoundProperty wrapper.

OBaseProperty Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getProperty ( size_t  i) const

Return a wrapped base property version of an ALREADY ADDED property. Will return an empty pointer if the writer for this property no longer exists or was never added. This would primarily be used for introspection.

OBaseProperty Alembic::Abc::ALEMBIC_VERSION_NS::OCompoundProperty::getProperty ( const std::string iName) const

Return a wrapped base property version of an ALREADY ADDED property. Will return an empty pointer if the writer for this property no longer exists or was never added. This would primarily be used for introspection.

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

Return the header of a property that has already been added. Property is selected by index. This will throw an exception on out-of-range access.

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

Return the header of a property that has already been added. Property is selected by name. This will return NULL if no property with the given name is found.


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