OpenVDB: MappedFile Class Reference

OpenVDB 3.1.0

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

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
typedef boost::shared_ptr< MappedFile > | Ptr
typedef boost::function< void(std::string)> | Notifier

## Public Member Functions
| ~MappedFile ()
std::string | filename () const
| Return the filename of the mapped file. More...
boost::shared_ptr< 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

## Detailed Description

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

## Member Typedef Documentation

typedef boost::function<void(std::string )> Notifier

typedef boost::shared_ptr<MappedFile> Ptr

## Constructor & Destructor Documentation

~MappedFile | ( |  | ) |

## Member Function Documentation

void clearNotifier | ( |  | ) |

Deregister the notifier.

boost::shared_ptr<std::streambuf> createBuffer | ( |  | ) | const

Return a new stream buffer for the mapped file.

Typical usage is

openvdb::io::MappedFile::Ptr mappedFile = ...;
boost::shared_ptr<std::streambuf> 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.

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 File
| friend

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

- io.h