HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IArchive.h
Go to the documentation of this file.
1 //-*****************************************************************************
2 //
3 // Copyright (c) 2013,
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 Industrial Light & Magic nor the names of
19 // its contributors may be used to endorse or promote products derived
20 // from this software without specific prior written permission.
21 //
22 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 //
34 //-*****************************************************************************
35 
36 #ifndef _Alembic_Ogawa_IArchive_h_
37 #define _Alembic_Ogawa_IArchive_h_
38 
39 #include <Alembic/Util/Export.h>
41 #include <Alembic/Ogawa/IStreams.h>
42 #include <Alembic/Ogawa/IGroup.h>
43 
44 #include <istream>
45 
46 namespace Alembic {
47 namespace Ogawa {
48 namespace ALEMBIC_VERSION_NS {
49 
51 {
52 public:
53  IArchive(const std::string & iFileName, std::size_t iNumStreams=1);
54  IArchive(const std::vector< std::istream * > & iStreams);
55  ~IArchive();
56 
57  bool isValid() const;
58 
59  bool isFrozen() const;
60 
61  Alembic::Util::uint16_t getVersion() const;
62 
63  IGroupPtr getGroup() const;
64 
65 private:
66  void init();
67  IStreamsPtr mStreams;
68  IGroupPtr mGroup;
69 };
70 
71 typedef Alembic::Util::shared_ptr< IArchive > IArchivePtr;
72 
73 } // End namespace ALEMBIC_VERSION_NS
74 
75 using namespace ALEMBIC_VERSION_NS;
76 
77 } // End namespace Ogawa
78 
79 } // End namespace Alembic
80 
81 #endif
int getVersion(int version)
Definition: ImfVersion.h:116
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
Alembic::Util::shared_ptr< IStreams > IStreamsPtr
Definition: IStreams.h:73
Alembic::Util::shared_ptr< IArchive > IArchivePtr
Definition: IArchive.h:71
#define ALEMBIC_EXPORT
Definition: Export.h:51
Alembic::Util::shared_ptr< IGroup > IGroupPtr
Definition: IGroup.h:48
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104