HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IStreams.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_IStreams_h_
37 #define _Alembic_Ogawa_IStreams_h_
38 
39 #include <Alembic/Util/Export.h>
41 
42 #include <istream>
43 
44 namespace Alembic {
45 namespace Ogawa {
46 namespace ALEMBIC_VERSION_NS {
47 
49 {
50 public:
51  IStreams(const std::string & iFileName, std::size_t iNumStreams=1);
52  IStreams(const std::vector< std::istream * > & iStreams);
53  ~IStreams();
54 
55  bool isValid();
56  bool isFrozen();
57  Alembic::Util::uint16_t getVersion();
58 
59  // locks on the threadId, seeks to iPos, and reads iSize bytes into oBuf
60  void read(std::size_t iThreadId, Alembic::Util::uint64_t iPos,
61  Alembic::Util::uint64_t iSize, void * oBuf);
62 
63 private:
64  // noncopyable
65  IStreams(const IStreams &);
66  const IStreams & operator=(const IStreams &);
67 
68  void init();
69 
70  class PrivateData;
71  Alembic::Util::unique_ptr< PrivateData > mData;
72 };
73 typedef Alembic::Util::shared_ptr< IStreams > IStreamsPtr;
74 
75 } // End namespace ALEMBIC_VERSION_NS
76 
77 using namespace ALEMBIC_VERSION_NS;
78 
79 } // End namespace Ogawa
80 
81 } // End namespace Alembic
82 
83 #endif
int getVersion(int version)
Definition: ImfVersion.h:116
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
void read(T &in, bool &v)
Definition: ImfXdr.h:611
Alembic::Util::shared_ptr< IStreams > IStreamsPtr
Definition: IStreams.h:73
#define ALEMBIC_EXPORT
Definition: Export.h:51
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104