HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter Class Referenceabstract

#include <CompoundPropertyWriter.h>

+ Inheritance diagram for Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter:

Public Member Functions

virtual ~CompoundPropertyWriter ()
 
virtual size_t getNumProperties ()=0
 
virtual const PropertyHeadergetPropertyHeader (size_t i)=0
 
virtual const PropertyHeadergetPropertyHeader (const std::string &iName)=0
 
BasePropertyWriterPtr getProperty (size_t i)
 
virtual BasePropertyWriterPtr getProperty (const std::string &iName)=0
 
virtual ScalarPropertyWriterPtr createScalarProperty (const std::string &iName, const MetaData &iMetaData, const DataType &iDataType, uint32_t iTimeSamplingIndex)=0
 
virtual ArrayPropertyWriterPtr createArrayProperty (const std::string &iName, const MetaData &iMetaData, const DataType &iDataType, uint32_t iTimeSamplingIndex)=0
 
virtual CompoundPropertyWriterPtr createCompoundProperty (const std::string &iName, const MetaData &iMetaData)=0
 
- Public Member Functions inherited from Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter
virtual ~BasePropertyWriter ()
 
virtual const PropertyHeadergetHeader () const =0
 
const std::stringgetName () const
 
PropertyType getPropertyType () const
 
bool isScalar () const
 
bool isArray () const
 
bool isCompound () const
 
bool isSimple () const
 
const MetaDatagetMetaData () const
 
const DataTypegetDataType () const
 
TimeSamplingPtr getTimeSampling () const
 
virtual ObjectWriterPtr getObject ()=0
 
virtual CompoundPropertyWriterPtr getParent ()=0
 
virtual ScalarPropertyWriterPtr asScalarPtr ()
 
virtual ArrayPropertyWriterPtr asArrayPtr ()
 
virtual CompoundPropertyWriterPtr asCompoundPtr ()
 

Detailed Description

A CompoundProperty is a group of other properties, possibly Simple or possibly Compound. Every object has at one of these.

Definition at line 51 of file CompoundPropertyWriter.h.

Constructor & Destructor Documentation

virtual Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::~CompoundPropertyWriter ( )
virtual

Virtual destructor ...

Member Function Documentation

virtual ArrayPropertyWriterPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::createArrayProperty ( const std::string iName,
const MetaData iMetaData,
const DataType iDataType,
uint32_t  iTimeSamplingIndex 
)
pure virtual

Create and return the requested array property. If a property already exists with the same name, throws. an exception. An exception will also be thrown if the DataType, or time sampling index is illegal.

virtual CompoundPropertyWriterPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::createCompoundProperty ( const std::string iName,
const MetaData iMetaData 
)
pure virtual

Create and return the requested compound property. If a property already exists with the same name, throws an exception.

virtual ScalarPropertyWriterPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::createScalarProperty ( const std::string iName,
const MetaData iMetaData,
const DataType iDataType,
uint32_t  iTimeSamplingIndex 
)
pure virtual

Create and return the requested scalar property. If a property already exists with the same name, throws an exception. An exception will also be thrown if the DataType, or time sampling index is illegal.

virtual size_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::getNumProperties ( )
pure virtual

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

BasePropertyWriterPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::getProperty ( size_t  i)

It is an error to request for a property by index out of range. This returns a property that has ALREADY BEEN ADDED. This will throw an exception on out-of-range access. There is a possibility it could return a NULL pointer, if the added property has been closed (deleted). This is just a convenience function which calls getPropertyHeader and then getProperty.

virtual BasePropertyWriterPtr Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::getProperty ( const std::string iName)
pure virtual

Returns an ALREADY ADDED PROPERTY by name. If it can't find one by name, it returns an empty pointer. This can also happen if the property was added, but has been closed (deleted).

virtual const PropertyHeader& Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::getPropertyHeader ( size_t  i)
pure virtual

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.

virtual const PropertyHeader* Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriter::getPropertyHeader ( const std::string iName)
pure virtual

Return the header of a property that has already been added, found by name. A typical use of this would be for an application that wants to incrementally add properties, and wishes to query whether a property of a given name has already been added, before attempting to add a new one. This will return NULL if no property of the given name has been added.


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