#include <IBaseProperty.h>

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

Collaboration diagram for Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >:

Public Member Functions
const AbcA::PropertyHeader &	getHeader () const
const std::string &	getName () const
AbcA::PropertyType	getPropertyType () const
bool	isScalar () const
bool	isArray () const
bool	isCompound () const
bool	isSimple () const
const AbcA::MetaData &	getMetaData () const
const AbcA::DataType &	getDataType () 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
ErrorHandler &	getErrorHandler () 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, ErrorHandler::Policy iPolicy)
Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
	Base ()
	Base (ErrorHandler::Policy iPolicy)
	Base (const Base &iCopy)
Base &	operator= (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

◆ operator_bool_base_type

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.

◆ this_type

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

◆ IBasePropertyT() [1/2]

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.

◆ IBasePropertyT() [2/2]

template<class PROP_PTR>

Alembic::Abc::ALEMBIC_VERSION_NS::IBasePropertyT< PROP_PTR >::IBasePropertyT	(	PROP_PTR	iPtr,
		ErrorHandler::Policy	iPolicy )

inlineprotected

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

Parameters

iPtr	The pointer ...
iPolicy	Optional error handling policy ...

Definition at line 181 of file IBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::Base::getErrorHandler(), m_property, and Alembic::Abc::ALEMBIC_VERSION_NS::ErrorHandler::setPolicy().

Here is the call graph for this function:

Member Function Documentation

◆ ALEMBIC_OPERATOR_BOOL()

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.

◆ getDataType()

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 133 of file IBaseProperty.h.

References getHeader().

Here is the call graph for this function:

◆ getHeader()

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 192 of file IBaseProperty.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, and m_property.

Referenced by getDataType(), getMetaData(), getName(), getPropertyType(), and getTimeSampling().

Here is the caller graph for this function:

◆ getMetaData()

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 126 of file IBaseProperty.h.

References getHeader().

Here is the call graph for this function:

◆ getName()

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 100 of file IBaseProperty.h.

References getHeader().

Here is the call graph for this function:

◆ getObject()

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 207 of file IBaseProperty.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, Alembic::Abc::ALEMBIC_VERSION_NS::Base::getErrorHandlerPolicy(), Alembic::Abc::ALEMBIC_VERSION_NS::kWrapExisting, and m_property.

Here is the call graph for this function:

◆ getPropertyType()

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 105 of file IBaseProperty.h.

References getHeader().

Referenced by isArray(), isCompound(), and isScalar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPtr()

template<class PROP_PTR>

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

inline

getPtr, as usual, returns a shared ptr to the underlying AbcCoreAbstract object, in this case the PROP_PTR.

Definition at line 156 of file IBaseProperty.h.

References m_property.

Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::ITypedArrayProperty< BooleanTPTraits >::ITypedArrayProperty(), Alembic::Abc::ALEMBIC_VERSION_NS::ITypedScalarProperty< BooleanTPTraits >::ITypedScalarProperty(), and Alembic::Abc::ALEMBIC_VERSION_NS::GetCompoundPropertyReaderPtr().

Here is the caller graph for this function:

◆ getTimeSampling()

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 140 of file IBaseProperty.h.

References getHeader().

Here is the call graph for this function: