OpenVDB  6.2.1
Public Types | Public Member Functions | Friends | List of all members
MappedFile Class Reference

Handle to control the lifetime of a memory-mapped .vdb file. More...

#include <io.h>

Public Types

using Ptr = SharedPtr< MappedFile >
 
using Notifier = std::function< void(std::string)>
 

Public Member Functions

 ~MappedFile ()
 
 MappedFile (const MappedFile &)=delete
 
MappedFileoperator= (const MappedFile &)=delete
 
std::string filename () const
 Return the filename of the mapped file. More...
 
SharedPtr< std::streambuf > createBuffer () const
 Return a new stream buffer for the mapped file. More...
 
void setNotifier (const Notifier &)
 Register a function that will be called with this file's name when the file is unmapped. More...
 
void clearNotifier ()
 Deregister the notifier. More...
 

Friends

class File
 
class ::TestMappedFile
 

Detailed Description

Handle to control the lifetime of a memory-mapped .vdb file.

Member Typedef Documentation

using Notifier = std::function<void(std::string )>

Constructor & Destructor Documentation

~MappedFile ( )
MappedFile ( const MappedFile )
delete

Member Function Documentation

void clearNotifier ( )

Deregister the notifier.

SharedPtr<std::streambuf> createBuffer ( ) const

Return a new stream buffer for the mapped file.

Typical usage is

openvdb::io::MappedFile::Ptr mappedFile = ...;
auto buf = mappedFile->createBuffer();
std::istream istrm{buf.get()};
// Read from istrm...

The buffer must persist as long as the stream is open.

std::string filename ( ) const

Return the filename of the mapped file.

MappedFile& operator= ( const MappedFile )
delete
void setNotifier ( const Notifier )

Register a function that will be called with this file's name when the file is unmapped.

Friends And Related Function Documentation

friend class ::TestMappedFile
friend
friend class File
friend

The documentation for this class was generated from the following file: