Templated metadata class to hold specific types. More...

#include <Metadata.h>

Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >:

Public Types
using	Ptr = SharedPtr< TypedMetadata< T >>

using	ConstPtr = SharedPtr< const TypedMetadata< T >>

Public Types inherited from openvdb::OPENVDB_VERSION_NAME::Metadata
using	Ptr = SharedPtr< Metadata >

using	ConstPtr = SharedPtr< const Metadata >

Public Member Functions
	TypedMetadata ()

	TypedMetadata (const T &value)

	TypedMetadata (const TypedMetadata< T > &other)

	~TypedMetadata () override

Name	typeName () const override
	Return the type name of the metadata. More...

Metadata::Ptr	copy () const override
	Return a copy of the metadata. More...

void	copy (const Metadata &other) override
	Copy the given metadata into this metadata. More...

std::string	str () const override
	Return a textual representation of this metadata. More...

bool	asBool () const override

Index32	size () const override
	Return the size of this metadata in bytes. More...

void	setValue (const T &)
	Set this metadata's value. More...

T &	value ()
	Return this metadata's value. More...

const T &	value () const

template<>
std::string	str () const
	Return a textual representation of this metadata. More...

Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::Metadata
	Metadata ()

virtual	~Metadata ()

	Metadata (const Metadata &)=delete

Metadata &	operator= (const Metadata &)=delete

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...

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 Name	staticTypeName ()

static Metadata::Ptr	createMetadata ()
	Create new metadata of this type. More...

static void	registerType ()

static void	unregisterType ()

static bool	isRegisteredType ()

Static Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::Metadata
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	readValue (std::istream &, Index32 numBytes) override
	Read the metadata from a stream. More...

void	writeValue (std::ostream &) const override
	Write the metadata to a stream. More...

Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::Metadata
void	writeSize (std::ostream &) const
	Write the size of the metadata to a stream. More...

Additional Inherited Members
Static Protected Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::Metadata
static Index32	readSize (std::istream &)
	Read the size of the metadata from a stream. More...

Detailed Description

template<typename T>
class openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >

Templated metadata class to hold specific types.

Definition at line 122 of file Metadata.h.

Member Typedef Documentation

template<typename T>

using openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::ConstPtr = SharedPtr<const TypedMetadata<T>>

Definition at line 126 of file Metadata.h.

template<typename T>

using openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::Ptr = SharedPtr<TypedMetadata<T>>

Definition at line 125 of file Metadata.h.

Constructor & Destructor Documentation

template<typename T >

openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::TypedMetadata ( )

inline

Definition at line 210 of file Metadata.h.

template<typename T >

openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::TypedMetadata ( const T & value )

inline

Definition at line 216 of file Metadata.h.

template<typename T >

openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::TypedMetadata ( const TypedMetadata< T > & other )

inline

Definition at line 222 of file Metadata.h.

template<typename T >

openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::~TypedMetadata ( )

inlineoverride

Definition at line 230 of file Metadata.h.

Member Function Documentation

template<typename T >

bool openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::asBool ( ) const

inlineoverridevirtual

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

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 307 of file Metadata.h.

template<typename T >

Metadata::Ptr openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::copy ( ) const

inlineoverridevirtual

Return a copy of the metadata.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 264 of file Metadata.h.

template<typename T >

void openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::copy ( const Metadata & other )

inlineoverridevirtual

Copy the given metadata into this metadata.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 273 of file Metadata.h.

template<typename T >

Metadata::Ptr openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::createMetadata ( )

inlinestatic

Create new metadata of this type.

Definition at line 314 of file Metadata.h.

template<typename T >

bool openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::isRegisteredType ( )

inlinestatic

Definition at line 337 of file Metadata.h.

void openvdb::OPENVDB_VERSION_NAME::StringMetadata::readValue	(	std::istream &	,
		Index32	numBytes
	)

inlineoverrideprotectedvirtual

Read the metadata from a stream.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 283 of file Metadata.h.

template<typename T >

void openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::registerType ( )

inlinestatic

Definition at line 322 of file Metadata.h.

template<typename T >

void openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::setValue ( const T & val )

inline

Set this metadata's value.

Definition at line 243 of file Metadata.h.

Index32 openvdb::OPENVDB_VERSION_NAME::StringMetadata::size ( ) const

inlineoverridevirtual

Return the size of this metadata in bytes.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 138 of file Metadata.h.

template<typename T>

static Name openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::staticTypeName ( )

inlinestatic

Definition at line 148 of file Metadata.h.

std::string openvdb::OPENVDB_VERSION_NAME::StringMetadata::str ( ) const

inlineoverridevirtual

Return a textual representation of this metadata.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 298 of file Metadata.h.

template<>

std::string openvdb::OPENVDB_VERSION_NAME::TypedMetadata< bool >::str ( ) const

inlinevirtual

Return a textual representation of this metadata.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 345 of file Metadata.h.

template<typename T >

Name openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::typeName ( ) const

inlineoverridevirtual

Return the type name of the metadata.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 236 of file Metadata.h.

template<typename T >

void openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::unregisterType ( )

inlinestatic

Definition at line 330 of file Metadata.h.

template<typename T >

T & openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::value ( )

inline

Return this metadata's value.

Definition at line 250 of file Metadata.h.

template<typename T >

const T & openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >::value ( ) const

inline

Definition at line 257 of file Metadata.h.

void openvdb::OPENVDB_VERSION_NAME::StringMetadata::writeValue ( std::ostream & ) const

inlineoverrideprotectedvirtual

Write the metadata to a stream.

Implements openvdb::OPENVDB_VERSION_NAME::Metadata.

Definition at line 291 of file Metadata.h.

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

openvdb/Metadata.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class openvdb::OPENVDB_VERSION_NAME::TypedMetadata< T >