HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CompoundPropertyReader.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2009-2011,
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_CompoundPropertyReader_h_
38 #define _Alembic_AbcCoreAbstract_CompoundPropertyReader_h_
39 
40 #include <Alembic/Util/Export.h>
45 
46 namespace Alembic {
47 namespace AbcCoreAbstract {
48 namespace ALEMBIC_VERSION_NS {
49 
50 //-*****************************************************************************
51 //! A CompoundProperty is a group of other properties, possibly Simple
52 //! or possibly Compound. Every object has at one of these.
54  : public BasePropertyReader
55 {
56 public:
57  //! Virtual destructor
58  //! ...
59  virtual ~CompoundPropertyReader();
60 
61  //-*************************************************************************
62  // NEW FUNCTIONS
63  //-*************************************************************************
64 
65  //! Returns the number of properties read from the file
66  //! ...
67  virtual size_t getNumProperties() = 0;
68 
69  //! Return the header of a property by index.
70  //! This will throw an exception on out-of-range access.
71  virtual const PropertyHeader & getPropertyHeader( size_t i ) = 0;
72 
73  //! Return the header of a property name.
74  //! This will return a NULL pointer if no header by that name is found.
75  virtual const PropertyHeader *
76  getPropertyHeader( const std::string &iName ) = 0;
77 
78  //! Get a Scalar Property by name..
79  //! It will return an empty pointer if the property is not scalar or
80  //! is not found.
82  getScalarProperty( const std::string &iName ) = 0;
83 
84  //! Get a Array Property by name..
85  //! It will return an empty pointer if the property is not array or
86  //! is not found.
88  getArrayProperty( const std::string &iName ) = 0;
89 
90  //! Get a Compound Property by name..
91  //! It will return an empty pointer if the property is not compound or
92  //! is not found.
94  getCompoundProperty( const std::string &iName ) = 0;
95 
96  //! Get a base property by name.
97  //! That property can be safely upcast.
98  //! This is a convenience function that uses getPropertyHeader and
99  //! the various named "get" functions here.
100  BasePropertyReaderPtr getProperty( const std::string &iName );
101 
102  //! Get a Scalar Property by index.
103  //! It will return an empty pointer if the property is not scalar or
104  //! is not found.
105  //! This is convenience function that uses the above functions
106  //! to get the answer.
108  getScalarProperty( size_t i );
109 
110  //! Get a Array Property by index.
111  //! It will return an empty pointer if the property is not array or
112  //! is not found.
113  //! This is convenience function that uses the above functions
114  //! to get the answer.
116  getArrayProperty( size_t i );
117 
118  //! Get a Compound Property by index.
119  //! It will return an empty pointer if the property is not compound or
120  //! is not found.
121  //! This is convenience function that uses the above functions
122  //! to get the answer.
124  getCompoundProperty( size_t i );
125 
126  //! Get a base property by index.
127  //! It is an error to call with out-of-range indices.
128  //! This is a convenience function that uses getPropertyHeader and
129  //! the various named "get" functions here.
130  BasePropertyReaderPtr getProperty( size_t i );
131 
132 };
133 
134 } // End namespace ALEMBIC_VERSION_NS
135 
136 using namespace ALEMBIC_VERSION_NS;
137 
138 } // End namespace AbcCoreAbstract
139 } // End namespace Alembic
140 
141 #endif
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Alembic::Util::shared_ptr< ArrayPropertyReader > ArrayPropertyReaderPtr
png_uint_32 i
Definition: png.h:2877
Alembic::Util::shared_ptr< CompoundPropertyReader > CompoundPropertyReaderPtr
Alembic::Util::shared_ptr< ScalarPropertyReader > ScalarPropertyReaderPtr
#define ALEMBIC_EXPORT
Definition: Export.h:51
Alembic::Util::shared_ptr< BasePropertyReader > BasePropertyReaderPtr
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104