Loading...
Searching...
No Matches
BasePropertyReader.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_BasePropertyReader_h
#define Alembic_AbcCoreAbstract_BasePropertyReader_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 BasePropertyReader
: private Alembic::Util::noncopyable
{
public:
virtual ~BasePropertyReader();
//-*************************************************************************
// 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 ObjectReaderPtr getObject() = 0;
virtual CompoundPropertyReaderPtr getParent() = 0;
virtual ScalarPropertyReaderPtr asScalarPtr();
virtual ArrayPropertyReaderPtr asArrayPtr();
virtual CompoundPropertyReaderPtr 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::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader
Base Property Reader.
Definition BasePropertyReader.h:53
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getObject
virtual ObjectReaderPtr getObject()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getDataType
const DataType & getDataType() const
Definition BasePropertyReader.h:109
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::asArrayPtr
virtual ArrayPropertyReaderPtr asArrayPtr()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getPropertyType
PropertyType getPropertyType() const
Definition BasePropertyReader.h:81
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::~BasePropertyReader
virtual ~BasePropertyReader()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getMetaData
const MetaData & getMetaData() const
Definition BasePropertyReader.h:102
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::asScalarPtr
virtual ScalarPropertyReaderPtr asScalarPtr()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::isSimple
bool isSimple() const
Definition BasePropertyReader.h:98
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::isScalar
bool isScalar() const
Definition BasePropertyReader.h:86
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::asCompoundPtr
virtual CompoundPropertyReaderPtr asCompoundPtr()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getHeader
virtual const PropertyHeader & getHeader() const =0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getParent
virtual CompoundPropertyReaderPtr getParent()=0
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getName
const std::string & getName() const
Definition BasePropertyReader.h:73
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::getTimeSampling
TimeSamplingPtr getTimeSampling() const
Definition BasePropertyReader.h:116
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::isCompound
bool isCompound() const
Definition BasePropertyReader.h:94
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyReader::isArray
bool isArray() const
Definition BasePropertyReader.h:90
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
Definition ArchiveReader.h:47
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArrayPropertyReaderPtr
Alembic::Util::shared_ptr< ArrayPropertyReader > ArrayPropertyReaderPtr
Definition ForwardDeclarations.h:93
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::TimeSamplingPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition TimeSampling.h:137
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ObjectReaderPtr
Alembic::Util::shared_ptr< ObjectReader > ObjectReaderPtr
Definition ForwardDeclarations.h:91
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::ScalarPropertyReaderPtr
Alembic::Util::shared_ptr< ScalarPropertyReader > ScalarPropertyReaderPtr
Definition ForwardDeclarations.h:94
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::CompoundPropertyReaderPtr
Alembic::Util::shared_ptr< CompoundPropertyReader > CompoundPropertyReaderPtr
Definition ForwardDeclarations.h:92
Alembic::AbcCoreAbstract
Definition ArchiveReader.h:46
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46