HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ArchiveReader.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_ArchiveReader_h
38 #define Alembic_AbcCoreAbstract_ArchiveReader_h
39 
40 #include <Alembic/Util/Export.h>
44 
45 namespace Alembic {
46 namespace AbcCoreAbstract {
47 namespace ALEMBIC_VERSION_NS {
48 
49 //-*****************************************************************************
50 //! In order for an implementation to concretely provide a starting point
51 //! for using the abstract API, a single "explicitly linked" function to
52 //! start from is necessary. That function will return, in the case of reading,
53 //! an ArchiveReaderPtr. This typedef provides a signature that such a function
54 //! should adhere to. This idiom is a workaround for the lack of virtual
55 //! constructors in C++, and to avoid creating another class (such as
56 //! "Implementation" or something similar)
57 //! This is provided here as an illustration. It does not need to be
58 //! derived from explicitly.
59 namespace IllustrationOnly {
61 {
62  // Create whatever cache is the default caching mechanism associated
63  // with the archive reader implementation
64  ArchiveReaderPtr operator()( const std::string &iFileName );
65 
66  // Use the explicitly supplied cache implementation.
67  ArchiveReaderPtr operator()( const std::string &iFileName,
68  ReadArraySampleCachePtr iCachePtr );
69 };
70 } // End namespace IllustrationOnly
71 
72 //-*****************************************************************************
73 //! The Archive is "the file". It has a single object, it's top object.
74 //! It has no properties, but does have metadata.
77 {
78 public:
79  //! Virtual destructor
80  //! ...
81  virtual ~ArchiveReader();
82 
83  //-*************************************************************************
84  // NEW FUNCTIONS
85  //-*************************************************************************
86 
87  //! Return the archive (file) name. This is the name of the file
88  //! which the root reader is associated with.
89  virtual const std::string &getName() const = 0;
90 
91  //! The meta data of the archive is the same as the meta data
92  //! of the top-level object reader.
93  virtual const MetaData &getMetaData() const = 0;
94 
95  //! Get (or open) a pointer to the top object reader
96  //! corresponding to this archive.
97  virtual ObjectReaderPtr getTop() = 0;
98 
99  //! Get the read array sample cache. It may be a NULL pointer.
100  //! Caches can be shared amongst separate archives, and caching
101  //! will is disabled if a NULL cache is returned here.
102  virtual ReadArraySampleCachePtr getReadArraySampleCachePtr() = 0;
103 
104  //! Set the read array sample cache. It may also be a NULL pointer.
105  //! Caches can be shared amongst separate archives, and caching
106  //! will be disabled if a NULL cache is passed here.
107  virtual void setReadArraySampleCachePtr( ReadArraySampleCachePtr iPtr ) = 0;
108 
109  //! Returns the TimeSampling at a given index.
110  virtual TimeSamplingPtr getTimeSampling( uint32_t iIndex ) = 0;
111 
112  //! Returns the maximum number of samples written for the TimeSampling at
113  //! the given index. If an illegal iIndex is specified, or a max
114  //! number of samplings couldn't be found for that iIndex
115  //! (for older archives pre 1.1.3) INDEX_UNKNOWN will be returned.
116  virtual index_t getMaxNumSamplesForTimeSamplingIndex( uint32_t iIndex ) = 0;
117 
118  //! Returns the total number of TimeSamplingPtrs in the Archive
119  //! TimeSampling pool.
120  virtual uint32_t getNumTimeSamplings() = 0;
121 
122  //! Returns the Alembic library numeric version (see Foundation.h)
123  //! of this archive file.
124  virtual int32_t getArchiveVersion() = 0;
125 
126  //! Return self
127  //! ...
128  virtual ArchiveReaderPtr asArchivePtr() = 0;
129 };
130 
131 } // End namespace ALEMBIC_VERSION_NS
132 
133 using namespace ALEMBIC_VERSION_NS;
134 
135 } // End namespace AbcCoreAbstract
136 } // End namespace Alembic
137 
138 #endif
139 
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Alembic::Util::shared_ptr< ObjectReader > ObjectReaderPtr
Alembic::Util::shared_ptr< TimeSampling > TimeSamplingPtr
Definition: TimeSampling.h:137
Alembic::Util::shared_ptr< ReadArraySampleCache > ReadArraySampleCachePtr
Alembic::Util::shared_ptr< ArchiveReader > ArchiveReaderPtr
Smart Ptrs to Readers.
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105