Alembic: AbcCoreAbstract/BasePropertyWriter.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
BasePropertyWriter.h
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_BasePropertyWriter_h
38#define Alembic_AbcCoreAbstract_BasePropertyWriter_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
45namespace Alembic {
46namespace AbcCoreAbstract {
47namespace ALEMBIC_VERSION_NS {
48
49//-*****************************************************************************
56 class ALEMBIC_EXPORT BasePropertyWriter
57 : private Alembic::Util::noncopyable
58{
59public:
62 virtual ~BasePropertyWriter();
63
64 //-*************************************************************************
65 // NEW FUNCTIONS
66 //-*************************************************************************
67
72 virtual const PropertyHeader & getHeader() const = 0;
73
78 const std::string &getName() const
79 { return getHeader().getName(); }
80
86 PropertyType getPropertyType() const
87 { return getHeader().getPropertyType(); }
88
91 bool isScalar() const { return getPropertyType() == kScalarProperty; }
92
95 bool isArray() const { return getPropertyType() == kArrayProperty; }
96
99 bool isCompound() const { return getPropertyType() == kCompoundProperty; }
100
103 bool isSimple() const { return !isCompound(); }
104
107 const MetaData &getMetaData() const
108 { return getHeader().getMetaData(); }
109
114 const DataType &getDataType() const
115 { return getHeader().getDataType(); }
116
121 TimeSamplingPtr getTimeSampling() const
122 { return getHeader().getTimeSampling(); }
123
127 virtual ObjectWriterPtr getObject() = 0;
128
132 virtual CompoundPropertyWriterPtr getParent() = 0;
133
139 virtual ScalarPropertyWriterPtr asScalarPtr();
140
146 virtual ArrayPropertyWriterPtr asArrayPtr();
147
153 virtual CompoundPropertyWriterPtr asCompoundPtr();
154};
155
156} // End namespace ALEMBIC_VERSION_NS
157
158using namespace ALEMBIC_VERSION_NS;
159
160} // End namespace AbcCoreAbstract
161} // End namespace Alembic
162
163#endif
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::asScalarPtr
virtual ScalarPropertyWriterPtr asScalarPtr()
Definition BasePropertyWriter.cpp:50
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::asCompoundPtr
virtual CompoundPropertyWriterPtr asCompoundPtr()
Definition BasePropertyWriter.cpp:64
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::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::isCompound
bool isCompound() const
Definition BasePropertyWriter.h:99
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::BasePropertyWriter::asArrayPtr
virtual ArrayPropertyWriterPtr asArrayPtr()
Definition BasePropertyWriter.cpp:57
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:98
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39