File.h

Go to the documentation of this file.

//
// Copyright (c) 2012-2018 DreamWorks Animation LLC
//
// All rights reserved. This software is distributed under the
// Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )
//
// Redistributions of source code must retain the above copyright
// and license notice and the following restrictions and disclaimer.
//
// *     Neither the name of DreamWorks Animation nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// IN NO EVENT SHALL THE COPYRIGHT HOLDERS' AND CONTRIBUTORS' AGGREGATE
// LIABILITY FOR ALL CLAIMS REGARDLESS OF THEIR BASIS EXCEED US$250.00.
//
//
 
#ifndef OPENVDB_IO_FILE_HAS_BEEN_INCLUDED
#define OPENVDB_IO_FILE_HAS_BEEN_INCLUDED
 
#include <openvdb/version.h>
#include "io.h" // for MappedFile::Notifier
#include "Archive.h"
#include "GridDescriptor.h"
#include <algorithm> // for std::copy()
#include <iosfwd>
#include <iterator> // for std::back_inserter()
#include <map>
#include <memory>
#include <string>
 
 
class TestFile;
class TestStream;
 
namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {
namespace io {
 
class OPENVDB_API File: public Archive
{
public:
    using NameMap = std::multimap<Name, GridDescriptor>;
    using NameMapCIter = NameMap::const_iterator;
 
    explicit File(const std::string& filename);
    ~File() override;
 
    File(const File& other);
    File& operator=(const File& other);
 
    SharedPtr<Archive> copy() const override;
 
    const std::string& filename() const;
 
    bool open(bool delayLoad = true, const MappedFile::Notifier& = MappedFile::Notifier());
 
    bool isOpen() const;
 
    void close();
 
    Index64 getSize() const;
 
    Index64 copyMaxBytes() const;
    void setCopyMaxBytes(Index64 bytes);
 
    bool hasGrid(const Name&) const;
 
    MetaMap::Ptr getMetadata() const;
 
    GridPtrVecPtr getGrids() const;
 
    GridPtrVecPtr readAllGridMetadata();
 
    GridBase::Ptr readGridMetadata(const Name&);
 
    GridBase::Ptr readGrid(const Name&);
#if OPENVDB_ABI_VERSION_NUMBER >= 3
    GridBase::Ptr readGrid(const Name&, const BBoxd&);
#endif
 
 
    void write(const GridCPtrVec&, const MetaMap& = MetaMap()) const override;
 
    template<typename GridPtrContainerT>
    void write(const GridPtrContainerT&, const MetaMap& = MetaMap()) const;
 
    class NameIterator
    {
    public:
        NameIterator(const NameMapCIter& iter): mIter(iter) {}
        NameIterator(const NameIterator&) = default;
        ~NameIterator() {}
 
        NameIterator& operator++() { mIter++; return *this; }
 
        bool operator==(const NameIterator& iter) const { return mIter == iter.mIter; }
        bool operator!=(const NameIterator& iter) const { return mIter != iter.mIter; }
 
        Name operator*() const { return this->gridName(); }
 
        Name gridName() const { return GridDescriptor::nameAsString(mIter->second.uniqueName()); }
 
    private:
        NameMapCIter mIter;
    };
 
    NameIterator beginName() const;
 
    NameIterator endName() const;
 
private:
    void readGridDescriptors(std::istream&);
 
    NameMapCIter findDescriptor(const Name&) const;
 
    GridBase::Ptr createGrid(const GridDescriptor&) const;
 
    GridBase::Ptr readGridByName(const Name&, const BBoxd&);
 
    GridBase::ConstPtr readGridPartial(const GridDescriptor&, bool readTopology) const;
 
    GridBase::Ptr readGrid(const GridDescriptor&) const;
#if OPENVDB_ABI_VERSION_NUMBER >= 3
    GridBase::Ptr readGrid(const GridDescriptor&, const BBoxd&) const;
    GridBase::Ptr readGrid(const GridDescriptor&, const CoordBBox&) const;
#endif
 
    void readGridPartial(GridBase::Ptr, std::istream&, bool isInstance, bool readTopology) const;
 
    GridBase::Ptr retrieveCachedGrid(const Name&) const;
 
    void writeGrids(const GridCPtrVec&, const MetaMap&) const;
 
    MetaMap::Ptr fileMetadata();
    MetaMap::ConstPtr fileMetadata() const;
 
    const NameMap& gridDescriptors() const;
    NameMap& gridDescriptors();
 
    std::istream& inputStream() const;
 
    friend class ::TestFile;
    friend class ::TestStream;
 
    struct Impl;
    std::unique_ptr<Impl> mImpl;
};
 
 
 
 
inline void
File::write(const GridCPtrVec& grids, const MetaMap& meta) const
{
    this->writeGrids(grids, meta);
}
 
 
template<typename GridPtrContainerT>
inline void
File::write(const GridPtrContainerT& container, const MetaMap& meta) const
{
    GridCPtrVec grids;
    std::copy(container.begin(), container.end(), std::back_inserter(grids));
    this->writeGrids(grids, meta);
}
 
} // namespace io
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb
 
#endif // OPENVDB_IO_FILE_HAS_BEEN_INCLUDED
 
// Copyright (c) 2012-2018 DreamWorks Animation LLC
// All rights reserved. This software is distributed under the
// Mozilla Public License 2.0 ( http://www.mozilla.org/MPL/2.0/ )