OpenVDB  6.1.0
Public Types | Public Member Functions | List of all members
StreamMetadata Class Reference

Container for metadata describing how to unserialize grids from and/or serialize grids to a stream (which file format, compression scheme, etc. to use) More...

#include <io.h>

Public Types

using Ptr = SharedPtr< StreamMetadata >
 
using ConstPtr = SharedPtr< const StreamMetadata >
 
using AuxDataMap = std::map< std::string, boost::any >
 

Public Member Functions

 StreamMetadata ()
 
 StreamMetadata (const StreamMetadata &)
 
 StreamMetadata (std::ios_base &)
 
 ~StreamMetadata ()
 
StreamMetadataoperator= (const StreamMetadata &)
 
void transferTo (std::ios_base &) const
 Transfer metadata items directly to the given stream. More...
 
uint32_t fileVersion () const
 
void setFileVersion (uint32_t)
 
VersionId libraryVersion () const
 
void setLibraryVersion (VersionId)
 
uint32_t compression () const
 
void setCompression (uint32_t)
 
uint32_t gridClass () const
 
void setGridClass (uint32_t)
 
const void * backgroundPtr () const
 
void setBackgroundPtr (const void *)
 
bool halfFloat () const
 
void setHalfFloat (bool)
 
bool writeGridStats () const
 
void setWriteGridStats (bool)
 
bool seekable () const
 
void setSeekable (bool)
 
bool countingPasses () const
 
void setCountingPasses (bool)
 
uint32_t pass () const
 
void setPass (uint32_t)
 
std::string str () const
 Return a string describing this stream metadata. More...
 
MetaMapgridMetadata ()
 Return a (reference to a) copy of the metadata of the grid currently being read or written. More...
 
const MetaMapgridMetadata () const
 Return a (reference to a) copy of the metadata of the grid currently being read or written. More...
 
AuxDataMapauxData ()
 Return a map that can be populated with arbitrary user data. More...
 
const AuxDataMapauxData () const
 Return a map that can be populated with arbitrary user data. More...
 

Detailed Description

Container for metadata describing how to unserialize grids from and/or serialize grids to a stream (which file format, compression scheme, etc. to use)

This class is mainly for internal use.

Member Typedef Documentation

using AuxDataMap = std::map<std::string, boost::any>

Constructor & Destructor Documentation

StreamMetadata ( std::ios_base &  )
explicit

Member Function Documentation

AuxDataMap& auxData ( )

Return a map that can be populated with arbitrary user data.

const AuxDataMap& auxData ( ) const

Return a map that can be populated with arbitrary user data.

const void* backgroundPtr ( ) const
uint32_t compression ( ) const
bool countingPasses ( ) const
uint32_t fileVersion ( ) const
uint32_t gridClass ( ) const
MetaMap& gridMetadata ( )

Return a (reference to a) copy of the metadata of the grid currently being read or written.

Some grid metadata might duplicate information returned by gridClass(), backgroundPtr() and other accessors, but those values are not guaranteed to be kept in sync.

const MetaMap& gridMetadata ( ) const

Return a (reference to a) copy of the metadata of the grid currently being read or written.

Some grid metadata might duplicate information returned by gridClass(), backgroundPtr() and other accessors, but those values are not guaranteed to be kept in sync.

bool halfFloat ( ) const
VersionId libraryVersion ( ) const
StreamMetadata& operator= ( const StreamMetadata )
uint32_t pass ( ) const
bool seekable ( ) const
void setBackgroundPtr ( const void *  )
void setCompression ( uint32_t  )
void setCountingPasses ( bool  )
void setFileVersion ( uint32_t  )
void setGridClass ( uint32_t  )
void setHalfFloat ( bool  )
void setLibraryVersion ( VersionId  )
void setPass ( uint32_t  )
void setSeekable ( bool  )
void setWriteGridStats ( bool  )
std::string str ( ) const

Return a string describing this stream metadata.

void transferTo ( std::ios_base &  ) const

Transfer metadata items directly to the given stream.

bool writeGridStats ( ) const

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