HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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>
44 
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48 
49 //-*****************************************************************************
50 //! Base Property Reader.
53 {
54 public:
55  //! Virtual destructor
56  //! ...
57  virtual ~BasePropertyReader();
58 
59  //-*************************************************************************
60  // NEW FUNCTIONS
61  //-*************************************************************************
62 
63  //! Properties are created with a collection of metadata that is stored
64  //! in a lightweight structure called PropertyHeader.
65  //! This returns a constant reference to the PropertyHeader which
66  //! was given upon creation.
67  virtual const PropertyHeader & getHeader() const = 0;
68 
69  //! All properties have a name, which is unique amongst its siblings
70  //! in the compund property they all live in. This is the name that
71  //! was given when the property was created, and is part of the property
72  //! header.
73  const std::string &getName() const
74  { return getHeader().getName(); }
75 
76  //! There are three types of abstract properties.
77  //! They are Scalar, Array, and Compound properties. This function
78  //! returns an enum PropertyType which indicates which property
79  //! type is returned. This is simply a convenience function which
80  //! returns data from the PropertyHeader.
82  { return getHeader().getPropertyType(); }
83 
84  //! Convenience to return whether the property is scalar.
85  //! Same as getPropertyType() == kScalarProperty
86  bool isScalar() const { return getPropertyType() == kScalarProperty; }
87 
88  //! Convenience to return whether the property is array.
89  //! Same as getPropertyType() == kArrayProperty
90  bool isArray() const { return getPropertyType() == kArrayProperty; }
91 
92  //! Convenience to return whether the property is compound.
93  //! Same as getPropertyType() == kCompoundProperty
94  bool isCompound() const { return getPropertyType() == kCompoundProperty; }
95 
96  //! Convenience to return whether the property is simple (non-compound)
97  //! Same as getPropertyType() != kCompoundProperty
98  bool isSimple() const { return !isCompound(); }
99 
100  //! All properties have MetaData. This just returns the
101  //! MetaData portion of the header that was used in creation.
102  const MetaData &getMetaData() const
103  { return getHeader().getMetaData(); }
104 
105  //! Non-compound properties have a DataType. It is an error
106  //! to call this function for CompoundProperties, and an exception will
107  //! be thrown. This is a convenience function which just returns the
108  //! DataType from the header that was used in creation.
109  const DataType &getDataType() const
110  { return getHeader().getDataType(); }
111 
112  //! Non-compound properties have a TimeSampling. It is an error
113  //! to call this function for CompoundProperties, and an exception will
114  //! be thrown. This is a convenience function which just returns the
115  //! TimeSampling from the header that was used in creation.
117  { return getHeader().getTimeSampling(); }
118 
119  //! All properties have an object that owns them, and in order to
120  //! ensure the object stays alive as long as the properties do, they
121  //! retain a shared pointer to their object.
122  virtual ObjectReaderPtr getObject() = 0;
123 
124  //! Most properties live in a compound property. (Except for
125  //! the top-compound property in any object)
126  //! This returns a pointer to the parent compound property.
127  virtual CompoundPropertyReaderPtr getParent() = 0;
128 
129  //! Up-cast this base property to a ScalarProperty, if such an
130  //! upcast is valid. This can be checked with the \ref isScalar()
131  //! function. If the upcast is not valid, an empty pointer will
132  //! be returned. This default implementation returns an empty
133  //! pointer.
134  virtual ScalarPropertyReaderPtr asScalarPtr();
135 
136  //! Up-cast this base property to an ArrayProperty, if such an
137  //! upcast is valid. This can be checked with the \ref isArray()
138  //! function. If the upcast is not valid, an empty pointer will
139  //! be returned. This default implementation returns an empty
140  //! pointer.
141  virtual ArrayPropertyReaderPtr asArrayPtr();
142 
143  //! Up-cast this base property to a CompoundProperty, if such an
144  //! upcast is valid. This can be checked with the \ref isCompound()
145  //! function. If the upcast is not valid, an empty pointer will
146  //! be returned. This default implementation returns an empty
147  //! pointer.
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
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Alembic::Util::shared_ptr< ObjectReader > ObjectReaderPtr
Alembic::Util::shared_ptr< ArrayPropertyReader > ArrayPropertyReaderPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::Util::shared_ptr< CompoundPropertyReader > CompoundPropertyReaderPtr
Alembic::Util::shared_ptr< ScalarPropertyReader > ScalarPropertyReaderPtr
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104