OpenVDB  5.2.0
Public Types | Public Member Functions | Friends | List of all members
PageHandle Class Reference

A PageHandle holds a shared ptr to a Page and a specific stream pointer to a point within the decompressed Page buffer. More...

#include <StreamCompression.h>

Public Types

using Ptr = std::shared_ptr< PageHandle >
 

Public Member Functions

 PageHandle (const Page::Ptr &page, const int index, const int size)
 Create the page handle. More...
 
Pagepage ()
 Retrieve a reference to the stored page. More...
 
std::unique_ptr< char[]> read ()
 Read and return the buffer, loading and decompressing the Page if necessary. More...
 

Friends

class ::TestStreamCompression
 

Detailed Description

A PageHandle holds a shared ptr to a Page and a specific stream pointer to a point within the decompressed Page buffer.

Member Typedef Documentation

◆ Ptr

using Ptr = std::shared_ptr<PageHandle>

Constructor & Destructor Documentation

◆ PageHandle()

PageHandle ( const Page::Ptr page,
const int  index,
const int  size 
)

Create the page handle.

Parameters
pagea shared ptr to the page that stores the buffer
indexstart position of the buffer to be read
sizetotal size of the buffer to be read in bytes

Member Function Documentation

◆ page()

Page& page ( )

Retrieve a reference to the stored page.

◆ read()

std::unique_ptr<char[]> read ( )

Read and return the buffer, loading and decompressing the Page if necessary.

Friends And Related Function Documentation

◆ ::TestStreamCompression

friend class ::TestStreamCompression
friend

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