Alembic Version 1.1

Loading...
Searching...
No Matches
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
40#include <Alembic/AbcCoreAbstract/All.h>
41#include <Alembic/Util/Export.h>
42
43 namespace Alembic {
44 namespace AbcCoreOgawa {
45 namespace ALEMBIC_VERSION_NS {
46
47//-*****************************************************************************
49 class ALEMBIC_EXPORT WriteArchive
50{
51 public:
52 WriteArchive();
53
54 ::Alembic::AbcCoreAbstract::ArchiveWriterPtr
55 operator()( const std::string &iFileName,
56 const ::Alembic::AbcCoreAbstract::MetaData &iMetaData ) const;
57
58 ::Alembic::AbcCoreAbstract::ArchiveWriterPtr
59 operator()( std::ostream * iStream,
60 const ::Alembic::AbcCoreAbstract::MetaData &iMetaData ) const;
61};
62
63//-*****************************************************************************
66 class ALEMBIC_EXPORT ReadArchive
67{
68 public:
69 ReadArchive();
70
71 // Open the file iNumStreams times and manage them internally. If iUseMMap
72 // is true, then use memory mapped file I/O, otherwise use file streams.
73 ReadArchive( size_t iNumStreams, bool iUseMMap );
74
75 // Read from the provided streams, we do not own these, expect them
76 // to remain open and all have the same data in them, and do not try to
77 // delete them
78 ReadArchive( const std::vector< std::istream * > & iStreams );
79
80 // open the file
81 ::Alembic::AbcCoreAbstract::ArchiveReaderPtr
82 operator()( const std::string &iFileName ) const;
83
84 // The given cache is ignored.
85 ::Alembic::AbcCoreAbstract::ArchiveReaderPtr
86 operator()( const std::string &iFileName,
87 ::Alembic::AbcCoreAbstract::ReadArraySampleCachePtr iCache
88 ) const;
89
90 private:
91 size_t m_numStreams;
92 bool m_useMMap;
93 std::vector< std::istream * > m_streams;
94};
95
96} // End namespace ALEMBIC_VERSION_NS
97
98 using namespace ALEMBIC_VERSION_NS;
99
100} // End namespace AbcCoreOgawa
101} // End namespace Alembic
102
103#endif
104
All.h
Export.h
ALEMBIC_EXPORT
#define ALEMBIC_EXPORT
Definition Export.h:51
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::ReadArchive::ReadArchive
ReadArchive(const std::vector< std::istream * > &iStreams)
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::ReadArchive::operator()
::Alembic::AbcCoreAbstract::ArchiveReaderPtr operator()(const std::string &iFileName, ::Alembic::AbcCoreAbstract::ReadArraySampleCachePtr iCache) const
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::ReadArchive::operator()
::Alembic::AbcCoreAbstract::ArchiveReaderPtr operator()(const std::string &iFileName) const
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::ReadArchive::ReadArchive
ReadArchive()
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::ReadArchive::ReadArchive
ReadArchive(size_t iNumStreams, bool iUseMMap)
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::WriteArchive::operator()
::Alembic::AbcCoreAbstract::ArchiveWriterPtr operator()(const std::string &iFileName, const ::Alembic::AbcCoreAbstract::MetaData &iMetaData) const
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::WriteArchive::operator()
::Alembic::AbcCoreAbstract::ArchiveWriterPtr operator()(std::ostream *iStream, const ::Alembic::AbcCoreAbstract::MetaData &iMetaData) const
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS::WriteArchive::WriteArchive
WriteArchive()
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveWriterPtr
Alembic::Util::shared_ptr< ArchiveWriter > ArchiveWriterPtr
Smart Ptrs to Writers.
Definition ForwardDeclarations.h:81
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ReadArraySampleCachePtr
Alembic::Util::shared_ptr< ReadArraySampleCache > ReadArraySampleCachePtr
Definition ReadArraySampleCache.h:138
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::ArchiveReaderPtr
Alembic::Util::shared_ptr< ArchiveReader > ArchiveReaderPtr
Smart Ptrs to Readers.
Definition ForwardDeclarations.h:90
Alembic::AbcCoreOgawa::ALEMBIC_VERSION_NS
Definition ReadWrite.h:45
Alembic::AbcCoreOgawa
Definition ReadWrite.h:44
Alembic
Alembic namespace ...
Definition ArchiveInfo.h:46