HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ReadWrite.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2013-2015,
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_AbcCoreOgawa_ReadWrite_h_
38 #define _Alembic_AbcCoreOgawa_ReadWrite_h_
39 
41 #include <Alembic/Util/Export.h>
42 
43 namespace Alembic {
44 namespace AbcCoreOgawa {
45 namespace ALEMBIC_VERSION_NS {
46 
47 //-*****************************************************************************
48 //! Will return a shared pointer to the archive writer
50 {
51 public:
52  WriteArchive();
53 
55  operator()( const std::string &iFileName,
56  const ::Alembic::AbcCoreAbstract::MetaData &iMetaData ) const;
57 
59  operator()( std::ostream * iStream,
60  const ::Alembic::AbcCoreAbstract::MetaData &iMetaData ) const;
61 };
62 
63 //-*****************************************************************************
64 //! Will return a shared pointer to the archive reader
65 //! This version creates a cache associated with the archive.
67 {
68 public:
69  ReadArchive();
70 
71  // Open the file iNumStreams times and manage them internally
72  ReadArchive( size_t iNumStreams );
73 
74  // Read from the provided streams, we do not own these, expect them
75  // to remain open and all have the same data in them, and do not try to
76  // delete them
77  ReadArchive( const std::vector< std::istream * > & iStreams );
78 
79  // open the file
81  operator()( const std::string &iFileName ) const;
82 
83  // The given cache is ignored.
85  operator()( const std::string &iFileName,
87  ) const;
88 
89 private:
90  size_t m_numStreams;
91  std::vector< std::istream * > m_streams;
92 };
93 
94 } // End namespace ALEMBIC_VERSION_NS
95 
96 using namespace ALEMBIC_VERSION_NS;
97 
98 } // End namespace AbcCoreOgawa
99 } // End namespace Alembic
100 
101 #endif
102 
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Will return a shared pointer to the archive writer.
Definition: ReadWrite.h:49
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:104