HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ReadWrite.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_AbcCoreHDF5_ReadWrite_h
38 #define Alembic_AbcCoreHDF5_ReadWrite_h
39 
41 #include <Alembic/Util/Export.h>
42 
43 namespace Alembic {
44 namespace AbcCoreHDF5 {
45 namespace ALEMBIC_VERSION_NS {
46 
47 //-*****************************************************************************
48 //! Will return a shared pointer to the archive writer
49 //! There is only one way to create an archive writer in AbcCoreHDF5.
51 {
52 public:
53  WriteArchive();
54  explicit WriteArchive( bool iCacheHierarchy );
55 
57  operator()( const std::string &iFileName,
58  const ::Alembic::AbcCoreAbstract::MetaData &iMetaData ) const;
59 private:
60  bool m_cacheHierarchy;
61 };
62 
63 //-*****************************************************************************
64 //! AbcCoreHDF5 Provides a Cache implementation, that we expose here.
65 //! It takes no arguments.
66 //! This would only be used if you wished to create a global cache separately
67 //! from an archive - this is actually fairly common, though, which is why
68 //! it is exposed here.
70 CreateCache( void );
71 
72 //-*****************************************************************************
73 //! Will return a shared pointer to the archive reader
74 //! This version creates a cache associated with the archive.
76 {
77 public:
78  ReadArchive();
79  explicit ReadArchive( bool iCacheHierarchy );
80 
81  // Make our own cache.
83  operator()( const std::string &iFileName ) const;
84 
85  // Take the given cache.
87  operator()( const std::string &iFileName,
89  ) const;
90 private:
91  bool m_cacheHierarchy;
92 };
93 
94 } // End namespace ALEMBIC_VERSION_NS
95 
96 using namespace ALEMBIC_VERSION_NS;
97 
98 } // End namespace AbcCoreHDF5
99 } // End namespace Alembic
100 
101 #endif
102 
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
ALEMBIC_EXPORT::Alembic::AbcCoreAbstract::ReadArraySampleCachePtr CreateCache(void)
Alembic::Util::shared_ptr< ReadArraySampleCache > ReadArraySampleCachePtr
Alembic::Util::shared_ptr< ArchiveReader > ArchiveReaderPtr
Smart Ptrs to Readers.
Alembic::Util::shared_ptr< ArchiveWriter > ArchiveWriterPtr
Smart Ptrs to Writers.
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:105