HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OData.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_OData_h_
37 #define _Alembic_Ogawa_OData_h_
38 
39 #include <Alembic/Util/Export.h>
41 #include <Alembic/Ogawa/OStream.h>
42 
43 namespace Alembic {
44 namespace Ogawa {
45 namespace ALEMBIC_VERSION_NS {
46 
48 {
49 public:
50 
51  // creates a default empty group
52  OData();
53 
54  ~OData();
55 
56  // rewrites over part of the already written data, does not change
57  // the size of the already written data. If what is attempting
58  // to be rewritten exceeds the boundaries of what is already written,
59  // the existing data will be unchanged
60  void rewrite(Alembic::Util::uint64_t iSize, void * iData,
61  Alembic::Util::uint64_t iOffset=0);
62 
63  Alembic::Util::uint64_t getSize() const;
64 
65 private:
66  friend class OGroup; // friend so we can call the constructor below
67  OData(OStreamPtr iStream, Alembic::Util::uint64_t iPos,
68  Alembic::Util::uint64_t iSize);
69 
70  Alembic::Util::uint64_t getPos() const;
71 
72  class PrivateData;
73  Alembic::Util::unique_ptr< PrivateData > mData;
74 };
75 
76 typedef Alembic::Util::shared_ptr< OData > ODataPtr;
77 
78 } // End namespace ALEMBIC_VERSION_NS
79 
80 using namespace ALEMBIC_VERSION_NS;
81 
82 } // End namespace Ogawa
83 
84 } // End namespace Alembic
85 
86 #endif
Alembic::Util::shared_ptr< OStream > OStreamPtr
Definition: OStream.h:76
#define ALEMBIC_EXPORT
Definition: Export.h:51
Alembic::Util::shared_ptr< OData > ODataPtr
Definition: OData.h:76
#define ALEMBIC_VERSION_NS
Definition: Foundation.h:104