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

#include <IBaseProperty.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >:

Public Member Functions

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
 
PROP_PTR 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 Types

typedef IBasePropertyT< PROP_PTR > this_type
 
typedef IBasePropertyT< PROP_PTR > operator_bool_base_type
 

Protected Member Functions

 IBasePropertyT ()
 
 IBasePropertyT (PROP_PTR iPtr, 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

PROP_PTR m_property
 

Detailed Description

template<class PROP_PTR>
class Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >

Most of the functionality of properties (getting information about the properties and so on) is common to all property types, so we create a base class to contain all that functionality. This is purely a base class for other properties to derive from, it will never be created directly.

Definition at line 57 of file IBaseProperty.h.

Member Typedef Documentation

template<class PROP_PTR>
typedef IBasePropertyT<PROP_PTR> Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::operator_bool_base_type
protected

Definition at line 64 of file IBaseProperty.h.

template<class PROP_PTR>
typedef IBasePropertyT<PROP_PTR> Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::this_type
protected

Definition at line 63 of file IBaseProperty.h.

Constructor & Destructor Documentation

template<class PROP_PTR>
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::IBasePropertyT ( )
inlineprotected

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

Definition at line 72 of file IBaseProperty.h.

template<class PROP_PTR>
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::IBasePropertyT ( PROP_PTR  iPtr,
WrapExistingFlag  iWrapFlag,
ErrorHandler::Policy  iPolicy 
)
inlineprotected

This attaches an IBasePropertyT wrapper around an existing PROP_PTR, with an optional error handling policy.

Parameters
iPtrThe pointer ...
iWrapFlagThe flag indicating that wrapping is intended. Even though it's nonambiguous here, we use it anyway for readability
iPolicyOptional error handling policy ...

Definition at line 190 of file IBaseProperty.h.

Member Function Documentation

template<class PROP_PTR>
Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::ALEMBIC_OPERATOR_BOOL ( valid()  )

The unspecified-bool-type operator casts the object to "true" if it is valid, and "false" otherwise.

template<class PROP_PTR>
const AbcA::DataType& Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getDataType ( ) const
inline

Non-compound properties have a DataType. It is an error to call this function for CompoundProperties, and an exception will be thrown. This is a convenience function which just returns the DataType from the header that was used in creation.

Definition at line 138 of file IBaseProperty.h.

template<class PROP_PTR >
const AbcA::PropertyHeader & Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getHeader ( ) const

Default copy constructor used Default assignment operator used. Return the property's header. ...

Definition at line 201 of file IBaseProperty.h.

template<class PROP_PTR>
const AbcA::MetaData& Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getMetaData ( ) const
inline

All properties have MetaData. This just returns the MetaData portion of the header that was used in creation.

Definition at line 131 of file IBaseProperty.h.

template<class PROP_PTR>
const std::string& Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getName ( ) const
inline

This function returns the property's local name ...

Definition at line 105 of file IBaseProperty.h.

template<class PROP_PTR >
IObject Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getObject ( ) const

This function returns the property's object, handily wrapped in an IObject wrapper.

Definition at line 216 of file IBaseProperty.h.

template<class PROP_PTR>
AbcA::PropertyType Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getPropertyType ( ) const
inline

This function returns the property's type ...

Definition at line 110 of file IBaseProperty.h.

template<class PROP_PTR>
PROP_PTR Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getPtr ( ) const
inline

Can't wrap OCompoundProperty getParent(); getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the PROP_PTR.

Definition at line 164 of file IBaseProperty.h.

template<class PROP_PTR>
AbcA::TimeSamplingPtr Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::getTimeSampling ( ) const
inline

Non-compound properties have a TimeSamplingPtr. It is an error to call this function for CompoundProperties, and an exception will be thrown. This is a convenience function which just returns the TimeSamplingPtr from the header that was used in creation.

Definition at line 145 of file IBaseProperty.h.

template<class PROP_PTR>
bool Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isArray ( ) const
inline

Convenience to return whether the property is array. Same as getPropertyType() == kArrayProperty

Definition at line 119 of file IBaseProperty.h.

template<class PROP_PTR>
bool Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isCompound ( ) const
inline

Convenience to return whether the property is compound. Same as getPropertyType() == kCompoundProperty

Definition at line 123 of file IBaseProperty.h.

template<class PROP_PTR>
bool Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isScalar ( ) const
inline

Convenience to return whether the property is scalar. Same as getPropertyType() == kScalarProperty

Definition at line 115 of file IBaseProperty.h.

template<class PROP_PTR>
bool Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::isSimple ( ) const
inline

Convenience to return whether the property is simple (non-compound) Same as getPropertyType() != kCompoundProperty

Definition at line 127 of file IBaseProperty.h.

template<class PROP_PTR>
void Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::reset ( )
inline

Reset returns this function set to an empty, default state.

Definition at line 168 of file IBaseProperty.h.

template<class PROP_PTR>
bool Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::valid ( ) const
inline

Valid returns whether this function set is valid.

Definition at line 172 of file IBaseProperty.h.

Member Data Documentation

template<class PROP_PTR>
PROP_PTR Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::m_property
protected

Definition at line 182 of file IBaseProperty.h.


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