Alembic: Ogawa/IStreams.h Source File

Alembic 1.8.11

Loading...
Searching...
No Matches
IStreams.h
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>
40#include <Alembic/Ogawa/Foundation.h>
41
42#include <istream>
43
44namespace Alembic {
45namespace Ogawa {
46namespace ALEMBIC_VERSION_NS {
47
48 class ALEMBIC_EXPORT IStreams
49{
50public:
51 IStreams(const std::string & iFileName,
52 std::size_t iNumStreams=1,
53 bool iUseMMap=true);
54 IStreams(const std::vector< std::istream * > & iStreams);
55 ~IStreams();
56
57 bool isValid();
58 bool isFrozen();
59 Alembic::Util::uint16_t getVersion();
60
61 Alembic::Util::uint64_t getSize();
62
63 // locks on the threadId, seeks to iPos, and reads iSize bytes into oBuf
64 void read(std::size_t iThreadId, Alembic::Util::uint64_t iPos,
65 Alembic::Util::uint64_t iSize, void * oBuf);
66
67private:
68 // noncopyable
69 IStreams(const IStreams &);
70 const IStreams & operator=(const IStreams &);
71
72 class PrivateData;
73 Alembic::Util::unique_ptr< PrivateData > mData;
74};
75typedef Alembic::Util::shared_ptr< IStreams > IStreamsPtr;
76
77} // End namespace ALEMBIC_VERSION_NS
78
79using namespace ALEMBIC_VERSION_NS;
80
81} // End namespace Ogawa
82
83} // End namespace Alembic
84
85#endif
Alembic::Ogawa::ALEMBIC_VERSION_NS::IStreams::PrivateData
Definition IStreams.cpp:655
Alembic
Alembic namespace ...
Definition ArchiveInfo.cpp:39