OpenVDB: Metadata Class Reference

OpenVDB 10.0.1

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
Metadata Class Referenceabstract

Base class for storing metadata information in a grid. More...

`#include <openvdb/Metadata.h>`

Inherited by TypedMetadata< T >, UnknownMetadata, and DelayedLoadMetadata.

## Public Types
using | Ptr = SharedPtr< Metadata >
using | ConstPtr = SharedPtr< const Metadata >

## Public Member Functions
| Metadata ()
virtual | ~Metadata ()
| Metadata (const Metadata &)=delete
Metadata & | operator= (const Metadata &)=delete
virtual Name | typeName () const =0
| Return the type name of the metadata. More...
virtual Metadata::Ptr | copy () const =0
| Return a copy of the metadata. More...
virtual void | copy (const Metadata &other)=0
| Copy the given metadata into this metadata. More...
virtual std::string | str () const =0
| Return a textual representation of this metadata. More...
virtual bool | asBool () const =0
bool | operator== (const Metadata &other) const
| Return `true` if the given metadata is equivalent to this metadata. More...
bool | operator!= (const Metadata &other) const
| Return `true` if the given metadata is different from this metadata. More...
virtual Index32 | size () const =0
| Return the size of this metadata in bytes. More...
void | read (std::istream &)
| Unserialize this metadata from a stream. More...
void | write (std::ostream &) const
| Serialize this metadata to a stream. More...

## Static Public Member Functions
static Metadata::Ptr | createMetadata (const Name &typeName)
| Create new metadata of the given type. More...
static bool | isRegisteredType (const Name &typeName)
| Return `true` if the given type is known by the metadata type registry. More...
static void | clearRegistry ()
| Clear out the metadata registry. More...
static void | registerType (const Name &typeName, Metadata::Ptr(*createMetadata)())
| Register the given metadata type along with a factory function. More...
static void | unregisterType (const Name &typeName)

## Protected Member Functions
void | writeSize (std::ostream &) const
| Write the size of the metadata to a stream. More...
virtual void | readValue (std::istream &, Index32 numBytes)=0
| Read the metadata from a stream. More...
virtual void | writeValue (std::ostream &) const =0
| Write the metadata to a stream. More...

## Static Protected Member Functions
static Index32 | readSize (std::istream &)
| Read the size of the metadata from a stream. More...

## Detailed Description

Base class for storing metadata information in a grid.

## Member Typedef Documentation

## ◆ ConstPtr

using ConstPtr = SharedPtr<const Metadata>

## ◆ Ptr

using Ptr = SharedPtr<Metadata>

## Constructor & Destructor Documentation

## ◆ Metadata() [1/2]

Metadata | ( |  | ) |
| inline

## ◆ ~Metadata()

virtual ~Metadata | ( |  | ) |
| inlinevirtual

## ◆ Metadata() [2/2]

Metadata | ( | const Metadata & |  | ) |
| delete

## Member Function Documentation

## ◆ asBool()

virtual bool asBool | ( |  | ) | const
| pure virtual

Return the boolean representation of this metadata (empty strings and zeroVals evaluate to false; most other values evaluate to true).

Implemented in DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.

## ◆ clearRegistry()

static void clearRegistry | ( |  | ) |
| static

Clear out the metadata registry.

## ◆ copy() [1/2]

virtual Metadata::Ptr copy | ( |  | ) | const
| pure virtual

Return a copy of the metadata.

Implemented in DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.

## ◆ copy() [2/2]

virtual void copy | ( | const Metadata & | other | ) |
| pure virtual

Copy the given metadata into this metadata.

Implemented in DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.

## ◆ createMetadata()

static Metadata::Ptr createMetadata | ( | const Name & | typeName | ) |
| static

Create new metadata of the given type.

## ◆ isRegisteredType()

static bool isRegisteredType | ( | const Name & | typeName | ) |
| static

Return `true` if the given type is known by the metadata type registry.

## ◆ operator!=()

bool operator!= | ( | const Metadata & | other | ) | const
| inline

Return `true` if the given metadata is different from this metadata.

## ◆ operator=()

Metadata & operator= | ( | const Metadata & |  | ) |
| delete

## ◆ operator==()

bool operator== | ( | const Metadata & | other | ) | const

Return `true` if the given metadata is equivalent to this metadata.

## ◆ read()

void read | ( | std::istream & | is | ) |
| inline

Unserialize this metadata from a stream.

## ◆ readSize()

Index32 readSize | ( | std::istream & | is | ) |
| inlinestaticprotected

Read the size of the metadata from a stream.

## ◆ readValue()

virtual void readValue | ( | std::istream & | ,
|  | Index32 | numBytes
| ) |  |
| protectedpure virtual

Read the metadata from a stream.

Implemented in DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.

## ◆ registerType()

static void registerType | ( | const Name & | typeName,
|  | Metadata::Ptr(*)() | createMetadata
| ) |  |
| static

Register the given metadata type along with a factory function.

## ◆ size()

virtual Index32 size | ( |  | ) | const
| pure virtual

Return the size of this metadata in bytes.

Implemented in DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.

## ◆ str()

virtual std::string str | ( |  | ) | const
| pure virtual

Return a textual representation of this metadata.

Implemented in TypedMetadata< T >, DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.

## ◆ typeName()

virtual Name typeName | ( |  | ) | const
| pure virtual

Return the type name of the metadata.

Implemented in DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.

## ◆ unregisterType()

static void unregisterType | ( | const Name & | typeName | ) |
| static

## ◆ write()

void write | ( | std::ostream & | os | ) | const
| inline

Serialize this metadata to a stream.

## ◆ writeSize()

void writeSize | ( | std::ostream & | os | ) | const
| inlineprotected

Write the size of the metadata to a stream.

## ◆ writeValue()

virtual void writeValue | ( | std::ostream & |  | ) | const
| protectedpure virtual

Write the metadata to a stream.

Implemented in DelayedLoadMetadata, UnknownMetadata, and TypedMetadata< T >.