HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::compression::PageHandle Class Reference

A PageHandle holds a unique 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...
 
int size () const
 Return the size of the buffer. More...
 
std::unique_ptr< char[]> read ()
 Read and return the buffer, loading and decompressing the Page if necessary. More...
 
Ptr copy ()
 Return a copy of this PageHandle. More...
 

Friends

class ::TestStreamCompression
 

Detailed Description

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

Definition at line 167 of file StreamCompression.h.

Member Typedef Documentation

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::compression::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

Ptr openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::copy ( )
inline

Return a copy of this PageHandle.

Definition at line 193 of file StreamCompression.h.

Page& openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::page ( )

Retrieve a reference to the stored page.

std::unique_ptr<char[]> openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::read ( )

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

int openvdb::OPENVDB_VERSION_NAME::compression::PageHandle::size ( void  ) const
inline

Return the size of the buffer.

Definition at line 186 of file StreamCompression.h.

Friends And Related Function Documentation

friend class ::TestStreamCompression
friend

Definition at line 196 of file StreamCompression.h.


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