Alembic Version 1.1
Loading...
Searching...
No Matches
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader Class Reference

#include <PropertyHeader.h>

Public Member Functions

 PropertyHeader ()
 PropertyHeader (const std::string &iName, const MetaData &iMetaData)
 PropertyHeader (const std::string &iName, PropertyType iPropType, const MetaData &iMetaData, const DataType &iDataType, const TimeSamplingPtr &iTsamp)
 PropertyHeader (const PropertyHeader &iCopy)
PropertyHeader & operator= (const PropertyHeader &iCopy)
const std::string & getName () const
void setName (const std::string &iName)
PropertyType getPropertyType () const
void setPropertyType (PropertyType iPtyp)
bool isScalar () const
bool isArray () const
bool isCompound () const
bool isSimple () const
const MetaData & getMetaData () const
void setMetaData (const MetaData &iMetaData)
const DataType & getDataType () const
void setDataType (const DataType &iDataType)
TimeSamplingPtr getTimeSampling () const
void setTimeSampling (const TimeSamplingPtr &iTsamp)

Detailed Description

The PropertyHeader is a collection of MetaData which helps define a Property. It also acts as a key for getting an instance of a property from a CompoundProperty.

Definition at line 78 of file PropertyHeader.h.

Constructor & Destructor Documentation

◆ PropertyHeader() [1/4]

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::PropertyHeader ( )
inline

Default constructor creates an invalid property. The propertyType is set to Scalar, but the dataType will be set to its default value of kUnknownPOD[1]

Definition at line 84 of file PropertyHeader.h.

References Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kScalarProperty.

Referenced by PropertyHeader(), and operator=().

Here is the caller graph for this function:

◆ PropertyHeader() [2/4]

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::PropertyHeader ( const std::string & iName,
const MetaData & iMetaData )
inlineexplicit

Construct a compound property header. Just give a name and metadata, the rest is redundant or unused.

Definition at line 93 of file PropertyHeader.h.

References Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kCompoundProperty.

◆ PropertyHeader() [3/4]

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::PropertyHeader ( const std::string & iName,
PropertyType iPropType,
const MetaData & iMetaData,
const DataType & iDataType,
const TimeSamplingPtr & iTsamp )
inline

Construct a simple property header. Use this for array or scalar properties.

Definition at line 103 of file PropertyHeader.h.

◆ PropertyHeader() [4/4]

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::PropertyHeader ( const PropertyHeader & iCopy)
inline

Copy constructor ...

Definition at line 116 of file PropertyHeader.h.

References PropertyHeader().

Here is the call graph for this function:

Member Function Documentation

◆ getDataType()

const DataType & Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getDataType ( ) const
inline

Non-compound properties have a data type. If this is called for a Compound Property (basically, one which returns kCompoundProperty from getType() above) it will throw an exception.

Definition at line 173 of file PropertyHeader.h.

◆ getMetaData()

const MetaData & Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getMetaData ( ) const
inline

All properties have metadata. ...

Definition at line 165 of file PropertyHeader.h.

◆ getName()

const std::string & Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getName ( ) const
inline

All properties have a name, which is unique amongst its siblings. ...

Definition at line 137 of file PropertyHeader.h.

◆ getPropertyType()

PropertyType Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getPropertyType ( ) const
inline

All properties have a type, which is the enum defined above. ...

Definition at line 143 of file PropertyHeader.h.

◆ getTimeSampling()

TimeSamplingPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::getTimeSampling ( ) const
inline

Non-compound properties have time sampling If this is called for a Compound Property (basically, one which returns kCompoundProperty from getType() above) it will throw an exception.

Definition at line 181 of file PropertyHeader.h.

◆ isArray()

bool Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::isArray ( ) const
inline

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

Definition at line 153 of file PropertyHeader.h.

References Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kArrayProperty.

◆ isCompound()

bool Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::isCompound ( ) const
inline

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

Definition at line 157 of file PropertyHeader.h.

References Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kCompoundProperty.

Referenced by isSimple().

Here is the caller graph for this function:

◆ isScalar()

bool Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::isScalar ( ) const
inline

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

Definition at line 149 of file PropertyHeader.h.

References Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kScalarProperty.

◆ isSimple()

bool Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::isSimple ( ) const
inline

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

Definition at line 161 of file PropertyHeader.h.

References isCompound().

Here is the call graph for this function:

◆ operator=()

PropertyHeader & Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::operator= ( const PropertyHeader & iCopy)
inline

Assignment operator ...

Definition at line 125 of file PropertyHeader.h.

References PropertyHeader().

Here is the call graph for this function:

◆ setDataType()

void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::setDataType ( const DataType & iDataType)
inline

Definition at line 175 of file PropertyHeader.h.

◆ setMetaData()

void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::setMetaData ( const MetaData & iMetaData)
inline

Definition at line 167 of file PropertyHeader.h.

◆ setName()

void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::setName ( const std::string & iName)
inline

Definition at line 139 of file PropertyHeader.h.

◆ setPropertyType()

void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::setPropertyType ( PropertyType iPtyp)
inline

Definition at line 145 of file PropertyHeader.h.

◆ setTimeSampling()

void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader::setTimeSampling ( const TimeSamplingPtr & iTsamp)
inline

Definition at line 184 of file PropertyHeader.h.

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