BasePropertyWriter.h
Go to the documentation of this file.
//-*****************************************************************************
//
// Copyright (c) 2009-2012,
// Sony Pictures Imageworks, Inc. and
// Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Sony Pictures Imageworks, nor
// Industrial Light & Magic nor the names of their contributors may be used
// to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//-*****************************************************************************
#ifndef Alembic_AbcCoreAbstract_BasePropertyWriter_h
#define Alembic_AbcCoreAbstract_BasePropertyWriter_h
#include <Alembic/Util/Export.h>
#include <Alembic/AbcCoreAbstract/Foundation.h>
#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
#include <Alembic/AbcCoreAbstract/PropertyHeader.h>
namespace Alembic {
namespace AbcCoreAbstract {
namespace ALEMBIC_VERSION_NS {
//-*****************************************************************************
class ALEMBIC_EXPORT BasePropertyWriter
: private Alembic::Util::noncopyable
{
public:
virtual ~BasePropertyWriter();
//-*************************************************************************
// NEW FUNCTIONS
//-*************************************************************************
virtual const PropertyHeader & getHeader() const = 0;
const std::string &getName() const
{ return getHeader().getName(); }
PropertyType getPropertyType() const
{ return getHeader().getPropertyType(); }
bool isScalar() const { return getPropertyType() == kScalarProperty; }
bool isArray() const { return getPropertyType() == kArrayProperty; }
bool isCompound() const { return getPropertyType() == kCompoundProperty; }
bool isSimple() const { return !isCompound(); }
const MetaData &getMetaData() const
{ return getHeader().getMetaData(); }
const DataType &getDataType() const
{ return getHeader().getDataType(); }
TimeSamplingPtr getTimeSampling() const
{ return getHeader().getTimeSampling(); }
virtual ObjectWriterPtr getObject() = 0;
virtual CompoundPropertyWriterPtr getParent() = 0;
virtual ScalarPropertyWriterPtr asScalarPtr();
virtual ArrayPropertyWriterPtr asArrayPtr();
virtual CompoundPropertyWriterPtr asCompoundPtr();
};
} // End namespace ALEMBIC_VERSION_NS
using namespace ALEMBIC_VERSION_NS;
} // End namespace AbcCoreAbstract
} // End namespace Alembic
#endif
Foundation.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition: Export.h:51
ForwardDeclarations.h
PropertyHeader.h
ALEMBIC_VERSION_NS
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter
Definition: BasePropertyWriter.h:58
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getMetaData
const MetaData & getMetaData() const
Definition: BasePropertyWriter.h:107
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::isArray
bool isArray() const
Definition: BasePropertyWriter.h:95
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::asCompoundPtr
virtual CompoundPropertyWriterPtr asCompoundPtr()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::asArrayPtr
virtual ArrayPropertyWriterPtr asArrayPtr()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::isScalar
bool isScalar() const
Definition: BasePropertyWriter.h:91
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getName
const std::string & getName() const
Definition: BasePropertyWriter.h:78
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::~BasePropertyWriter
virtual ~BasePropertyWriter()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::isSimple
bool isSimple() const
Definition: BasePropertyWriter.h:103
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getDataType
const DataType & getDataType() const
Definition: BasePropertyWriter.h:114
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getHeader
virtual const PropertyHeader & getHeader() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getParent
virtual CompoundPropertyWriterPtr getParent()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::asScalarPtr
virtual ScalarPropertyWriterPtr asScalarPtr()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::isCompound
bool isCompound() const
Definition: BasePropertyWriter.h:99
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getPropertyType
PropertyType getPropertyType() const
Definition: BasePropertyWriter.h:86
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getObject
virtual ObjectWriterPtr getObject()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::getTimeSampling
TimeSamplingPtr getTimeSampling() const
Definition: BasePropertyWriter.h:121
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType
Definition: DataType.h:52
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::MetaData
Definition: MetaData.h:60
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyHeader
Definition: PropertyHeader.h:79
Alembic::Util::ALEMBIC_VERSION_NS::noncopyable
Definition: Foundation.h:115
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyWriterPtr
Alembic::Util::shared_ptr< CompoundPropertyWriter > CompoundPropertyWriterPtr
Definition: ForwardDeclarations.h:83
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectWriterPtr
Alembic::Util::shared_ptr< ObjectWriter > ObjectWriterPtr
Definition: ForwardDeclarations.h:82
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::PropertyType
PropertyType
Definition: PropertyHeader.h:57
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kCompoundProperty
@ kCompoundProperty
Definition: PropertyHeader.h:62
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kArrayProperty
@ kArrayProperty
Definition: PropertyHeader.h:71
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::kScalarProperty
@ kScalarProperty
Definition: PropertyHeader.h:66
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyWriterPtr
Alembic::Util::shared_ptr< ArrayPropertyWriter > ArrayPropertyWriterPtr
Definition: ForwardDeclarations.h:84
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ScalarPropertyWriterPtr
Alembic::Util::shared_ptr< ScalarPropertyWriter > ScalarPropertyWriterPtr
Definition: ForwardDeclarations.h:85
Alembic
Alembic namespace ...
Definition: ArchiveInfo.h:46