Alembic Version 1.1

BasePropertyReader.h
Go to the documentation of this file.
1//-*****************************************************************************
2//
3// Copyright (c) 2009-2012,
4// Sony Pictures Imageworks, Inc. and
5// Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
6//
7// All rights reserved.
8//
9// Redistribution and use in source and binary forms, with or without
10// modification, are permitted provided that the following conditions are
11// met:
12// * Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14// * Redistributions in binary form must reproduce the above
15// copyright notice, this list of conditions and the following disclaimer
16// in the documentation and/or other materials provided with the
17// distribution.
18// * Neither the name of Sony Pictures Imageworks, nor
19// Industrial Light & Magic nor the names of their contributors may be used
20// to endorse or promote products derived from this software without specific
21// prior written permission.
22//
23// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34//
35//-*****************************************************************************
36
37#ifndef Alembic_AbcCoreAbstract_BasePropertyReader_h
38#define Alembic_AbcCoreAbstract_BasePropertyReader_h
39
40#include <Alembic/Util/Export.h>
41#include <Alembic/AbcCoreAbstract/Foundation.h>
42#include <Alembic/AbcCoreAbstract/ForwardDeclarations.h>
43#include <Alembic/AbcCoreAbstract/PropertyHeader.h>
44
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
51 class ALEMBIC_EXPORT BasePropertyReader
52 : private Alembic::Util::noncopyable
53{
54 public:
57 virtual ~BasePropertyReader();
58
59 //-*************************************************************************
60 // NEW FUNCTIONS
61 //-*************************************************************************
62
67 virtual const PropertyHeader & getHeader() const = 0;
68
73 const std::string &getName() const
74 { return getHeader().getName(); }
75
81 PropertyType getPropertyType() const
82 { return getHeader().getPropertyType(); }
83
86 bool isScalar() const { return getPropertyType() == kScalarProperty; }
87
90 bool isArray() const { return getPropertyType() == kArrayProperty; }
91
94 bool isCompound() const { return getPropertyType() == kCompoundProperty; }
95
98 bool isSimple() const { return !isCompound(); }
99
102 const MetaData &getMetaData() const
103 { return getHeader().getMetaData(); }
104
109 const DataType &getDataType() const
110 { return getHeader().getDataType(); }
111
116 TimeSamplingPtr getTimeSampling() const
117 { return getHeader().getTimeSampling(); }
118
122 virtual ObjectReaderPtr getObject() = 0;
123
127 virtual CompoundPropertyReaderPtr getParent() = 0;
128
134 virtual ScalarPropertyReaderPtr asScalarPtr();
135
141 virtual ArrayPropertyReaderPtr asArrayPtr();
142
148 virtual CompoundPropertyReaderPtr asCompoundPtr();
149};
150
151} // End namespace ALEMBIC_VERSION_NS
152
153 using namespace ALEMBIC_VERSION_NS;
154
155} // End namespace AbcCoreAbstract
156} // End namespace Alembic
157
158#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::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::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
Alembic namespace ...
Definition: ArchiveInfo.h:46