Alembic Version 1.1

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR > Class Template Reference

`#include <OBaseProperty.h>`

Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >:
[legend]
Collaboration diagram for Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >:
[legend]

## Public Types
typedef OBasePropertyT< PROP_PTR > | this_type
typedef OBasePropertyT< PROP_PTR > | operator_bool_base_type

## 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
OObject | 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 Member Functions
| OBasePropertyT ()
| OBasePropertyT (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

## Friends
class | OCompoundProperty

## Detailed Description

template<class PROP_PTR>
class Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< 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 OBaseProperty.h.

## Member Typedef Documentation

## ◆ operator_bool_base_type

template<class PROP_PTR >

typedef OBasePropertyT<PROP_PTR> Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::operator_bool_base_type

Definition at line 63 of file OBaseProperty.h.

## ◆ this_type

template<class PROP_PTR >

typedef OBasePropertyT<PROP_PTR> Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::this_type

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

Definition at line 62 of file OBaseProperty.h.

## Constructor & Destructor Documentation

## ◆ OBasePropertyT() [1/2]

template<class PROP_PTR >

Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::OBasePropertyT | ( |  | ) |
| inline protected

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

Definition at line 74 of file OBaseProperty.h.

## ◆ OBasePropertyT() [2/2]

template<class PROP_PTR >

Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::OBasePropertyT | ( | PROP_PTR | iPtr,
|  | ErrorHandler::Policy | iPolicy
| ) |  |
| inline protected

This attaches an OBaseProperty wrapper around an existing PROP_PTR, with the given error handler policy

Parameters

  iPtr | The pointer ...
  iPolicy | The error handling. ...

Definition at line 192 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::Base::getErrorHandler(), 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::OBasePropertyT< 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::OBasePropertyT< 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 136 of file OBaseProperty.h.

References Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getDataType(), and Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getHeader().

Here is the call graph for this function:

## ◆ getHeader()

template<class PROP_PTR >

const AbcA::PropertyHeader & Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getHeader

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

Definition at line 211 of file OBaseProperty.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, and ALEMBIC_ABC_SAFE_CALL_END.

Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getDataType(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getMetaData(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getName(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getTimeSampling().

Here is the caller graph for this function:

## ◆ getMetaData()

template<class PROP_PTR >

const AbcA::MetaData & Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< 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 129 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getMetaData().

Here is the call graph for this function:

## ◆ getName()

template<class PROP_PTR >

const std::string & Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getName | ( |  | ) | const
| inline

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

Definition at line 102 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getName().

Here is the call graph for this function:

## ◆ getObject()

template<class PROP_PTR >

OObject Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getObject

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

Definition at line 225 of file OBaseProperty.h.

References ALEMBIC_ABC_SAFE_CALL_BEGIN, ALEMBIC_ABC_SAFE_CALL_END, and Alembic::Abc::ALEMBIC_VERSION_NS::kWrapExisting.

## ◆ getPropertyType()

template<class PROP_PTR >

AbcA::PropertyType Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getPropertyType | ( |  | ) | const
| inline

This function returns the property's type ...

Definition at line 107 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getPropertyType().

Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isArray(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isCompound(), and Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::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::OBasePropertyT< 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 162 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::m_property.

Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OSchema< INFO >::OSchema(), Alembic::Abc::ALEMBIC_VERSION_NS::OTypedArrayProperty< TRAITS >::OTypedArrayProperty(), Alembic::AbcGeom::ALEMBIC_VERSION_NS::OTypedGeomParam< TRAITS >::OTypedGeomParam(), Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::OTypedScalarProperty(), and Alembic::Abc::ALEMBIC_VERSION_NS::GetCompoundPropertyWriterPtr().

Here is the caller graph for this function:

## ◆ getTimeSampling()

template<class PROP_PTR >

AbcA::TimeSamplingPtr Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< 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 143 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getHeader(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getTimeSampling().

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< INFO >::getChildBoundsProperty().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ isArray()

template<class PROP_PTR >

bool Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isArray | ( |  | ) | const
| inline

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

Definition at line 116 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kArrayProperty.

Here is the call graph for this function:

## ◆ isCompound()

template<class PROP_PTR >

bool Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isCompound | ( |  | ) | const
| inline

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

Definition at line 120 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kCompoundProperty.

Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isSimple().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ isScalar()

template<class PROP_PTR >

bool Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isScalar | ( |  | ) | const
| inline

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

Definition at line 112 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getPropertyType(), and Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kScalarProperty.

Here is the call graph for this function:

## ◆ isSimple()

template<class PROP_PTR >

bool Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isSimple | ( |  | ) | const
| inline

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

Definition at line 125 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::isCompound().

Here is the call graph for this function:

## ◆ reset()

template<class PROP_PTR >

void Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::reset | ( |  | ) |
| inline

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

Definition at line 166 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::m_property, and Alembic::Abc::ALEMBIC_VERSION_NS::Base::reset().

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< INFO >::reset(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::OTypedGeomParam< TRAITS >::reset().

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ valid()

template<class PROP_PTR >

bool Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::valid | ( |  | ) | const
| inline

Valid returns whether this function set is valid.

Definition at line 170 of file OBaseProperty.h.

References Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::m_property, and Alembic::Abc::ALEMBIC_VERSION_NS::Base::valid().

Referenced by Alembic::AbcGeom::ALEMBIC_VERSION_NS::OGeomBaseSchema< INFO >::createSelfBoundsProperty(), and Alembic::AbcGeom::ALEMBIC_VERSION_NS::OCameraSchema::valid().

Here is the call graph for this function:
Here is the caller graph for this function:

## Friends And Related Function Documentation

## ◆ OCompoundProperty

template<class PROP_PTR >

friend class OCompoundProperty
| friend

Definition at line 66 of file OBaseProperty.h.

## Member Data Documentation

## ◆ m_property

template<class PROP_PTR >

PROP_PTR Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::m_property
| protected

Definition at line 180 of file OBaseProperty.h.

Referenced by Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::getPtr(), Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::reset(), and Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< PROP_PTR >::valid().

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

- opt/local/include/Alembic/Abc/OBaseProperty.h