Alembic Version 1.1
Loading...
Searching...
No Matches
OBaseProperty.h
Go to the documentation of this file.
1//-*****************************************************************************
2//
3// Copyright (c) 2009-2013,
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_Abc_OBaseProperty_h
38#define Alembic_Abc_OBaseProperty_h
39
41#include <Alembic/Abc/Base.h>
43#include <Alembic/Abc/OObject.h>
45
46namespace Alembic {
47namespace Abc {
48namespace ALEMBIC_VERSION_NS {
49
50//-*****************************************************************************
56template <class PROP_PTR>
57class OBasePropertyT : public Base
58{
59public:
64
65protected:
66 friend class OCompoundProperty;
67
68 //-*************************************************************************
69 // CONSTRUCTION, DESTRUCTION, ASSIGNMENT
70 //-*************************************************************************
71
75
79
82 PROP_PTR iPtr,
83
86 ErrorHandler::Policy iPolicy );
87
90
91public:
92 //-*************************************************************************
93 // PROPERTY WRITER FUNCTIONALITY
94 //-*************************************************************************
95
99
102 const std::string &getName() const
103 { return getHeader().getName(); }
104
109
112 bool isScalar() const { return getPropertyType() == AbcA::kScalarProperty; }
113
116 bool isArray() const { return getPropertyType() == AbcA::kArrayProperty; }
117
120 bool isCompound() const { return getPropertyType() ==
122
125 bool isSimple() const { return !isCompound(); }
126
130 { return getHeader().getMetaData(); }
131
137 { return getHeader().getDataType(); }
138
145
149
152
153 //-*************************************************************************
154 // ABC BASE MECHANISMS
155 // These functions are used by Abc to deal with errors, rewrapping,
156 // and so on.
157 //-*************************************************************************
158
162 PROP_PTR getPtr() const { return m_property; }
163
166 void reset() { m_property.reset(); Base::reset(); }
167
170 bool valid() const
171 {
172 return ( Base::valid() && m_property );
173 }
174
178
179protected:
180 PROP_PTR m_property;
181};
182
183//-*****************************************************************************
185
186//-*****************************************************************************
187// TEMPLATE AND INLINE FUNCTIONS
188//-*****************************************************************************
189
190//-*****************************************************************************
191template <class PROP_PTR>
193(
194 PROP_PTR iPtr,
195 ErrorHandler::Policy iPolicy )
196 : m_property( iPtr )
197{
198 getErrorHandler().setPolicy( iPolicy );
199}
200
201namespace {
202
203const AbcA::PropertyHeader g_phd;
204
205}
206
207//-*****************************************************************************
208//-*****************************************************************************
209//-*****************************************************************************
210template <class PROP_PTR>
212{
213 ALEMBIC_ABC_SAFE_CALL_BEGIN( "OBaseProperty::getHeader()" );
214
215 return m_property->getHeader();
216
218
219 // Not all error handlers throw, so have a default behavior.
220 return g_phd;
221};
222
223//-*****************************************************************************
224template <class PROP_PTR>
226{
227 ALEMBIC_ABC_SAFE_CALL_BEGIN( "OBaseProperty::getObject()" );
228
229 return OObject( m_property->getObject(),
231 getErrorHandlerPolicy() );
232
234
235 // Not all error handlers throw. Have a default.
236 return OObject();
237}
238
239} // End namespace ALEMBIC_VERSION_NS
240
241using namespace ALEMBIC_VERSION_NS;
242
243} // End namespace Abc
244} // End namespace Alembic
245
246#endif
#define ALEMBIC_ABC_SAFE_CALL_END()
#define ALEMBIC_ABC_SAFE_CALL_BEGIN(CONTEXT)
#define ALEMBIC_VERSION_NS
Definition Foundation.h:105
ErrorHandler & getErrorHandler() const
Definition Base.h:76
const AbcA::PropertyHeader & getHeader() const
OBasePropertyT(PROP_PTR iPtr, ErrorHandler::Policy iPolicy)
OBasePropertyT< PROP_PTR > operator_bool_base_type
AbcA::TimeSamplingPtr getTimeSampling() const
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
OBasePropertyT< AbcA::BasePropertyWriterPtr > OBaseProperty
Alembic namespace ...
Definition ArchiveInfo.h:46