OpenVDB: openvdb/Metadata.h Source File

OpenVDB 10.0.1

Metadata.h
Go to the documentation of this file.
1// Copyright Contributors to the OpenVDB Project
2// SPDX-License-Identifier: MPL-2.0
3
4#ifndef OPENVDB_METADATA_HAS_BEEN_INCLUDED
5#define OPENVDB_METADATA_HAS_BEEN_INCLUDED
6
7#include "version.h"
8#include "Exceptions.h"
9#include "Types.h"
10#include "math/Math.h" // for math::isZero()
11#include "util/Name.h"
12#include <cstdint>
13#include <iostream>
14#include <string>
15#include <vector>
16
17
18namespace openvdb {
19 OPENVDB_USE_VERSION_NAMESPACE
20namespace OPENVDB_VERSION_NAME {
21
22/// @brief Base class for storing metadata information in a grid.
23 class OPENVDB_API Metadata
24{
25public:
26 using Ptr = SharedPtr<Metadata>;
27 using ConstPtr = SharedPtr<const Metadata>;
28
29 Metadata() {}
30 virtual ~Metadata() {}
31
32 // Disallow copying of instances of this class.
33 Metadata(const Metadata&) = delete;
34 Metadata& operator=(const Metadata&) = delete;
35
36 /// Return the type name of the metadata.
37 virtual Name typeName() const = 0;
38
39 /// Return a copy of the metadata.
40 virtual Metadata::Ptr copy() const = 0;
41
42 /// Copy the given metadata into this metadata.
43 virtual void copy(const Metadata& other) = 0;
44
45 /// Return a textual representation of this metadata.
46 virtual std::string str() const = 0;
47
48 /// Return the boolean representation of this metadata (empty strings
49 /// and zeroVals evaluate to false; most other values evaluate to true).
50 virtual bool asBool() const = 0;
51
52 /// Return @c true if the given metadata is equivalent to this metadata.
53 bool operator==(const Metadata& other) const;
54 /// Return @c true if the given metadata is different from this metadata.
55 bool operator!=(const Metadata& other) const { return !(*this == other); }
56
57 /// Return the size of this metadata in bytes.
58 virtual Index32 size() const = 0;
59
60 /// Unserialize this metadata from a stream.
61 void read(std::istream&);
62 /// Serialize this metadata to a stream.
63 void write(std::ostream&) const;
64
65 /// Create new metadata of the given type.
66 static Metadata::Ptr createMetadata(const Name& typeName);
67
68 /// Return @c true if the given type is known by the metadata type registry.
69 static bool isRegisteredType(const Name& typeName);
70
71 /// Clear out the metadata registry.
72 static void clearRegistry();
73
74 /// Register the given metadata type along with a factory function.
75 static void registerType(const Name& typeName, Metadata::Ptr (*createMetadata)());
76 static void unregisterType(const Name& typeName);
77
78protected:
79 /// Read the size of the metadata from a stream.
80 static Index32 readSize(std::istream&);
81 /// Write the size of the metadata to a stream.
82 void writeSize(std::ostream&) const;
83
84 /// Read the metadata from a stream.
85 virtual void readValue(std::istream&, Index32 numBytes) = 0;
86 /// Write the metadata to a stream.
87 virtual void writeValue(std::ostream&) const = 0;
88};
89
90
91/// @brief Subclass to hold raw data of an unregistered type
92 class OPENVDB_API UnknownMetadata: public Metadata
93{
94public:
95 using ByteVec = std::vector<uint8_t>;
96
97 explicit UnknownMetadata(const Name& typ = "<unknown>"): mTypeName(typ) {}
98
99 Name typeName() const override { return mTypeName; }
100 Metadata::Ptr copy() const override;
101 void copy(const Metadata&) override;
102 std::string str() const override { return (mBytes.empty() ? "" : "<binary data>"); }
103 bool asBool() const override { return !mBytes.empty(); }
104 Index32 size() const override { return static_cast<Index32>(mBytes.size()); }
105
106 void setValue(const ByteVec& bytes) { mBytes = bytes; }
107 const ByteVec& value() const { return mBytes; }
108
109protected:
110 void readValue(std::istream&, Index32 numBytes) override;
111 void writeValue(std::ostream&) const override;
112
113private:
114 Name mTypeName;
115 ByteVec mBytes;
116};
117
118
119/// @brief Templated metadata class to hold specific types.
120template<typename T>
121 class TypedMetadata: public Metadata
122{
123public:
124 using Ptr = SharedPtr<TypedMetadata<T>>;
125 using ConstPtr = SharedPtr<const TypedMetadata<T>>;
126
127 TypedMetadata();
128 TypedMetadata(const T& value);
129 TypedMetadata(const TypedMetadata<T>& other);
130 ~TypedMetadata() override;
131
132 Name typeName() const override;
133 Metadata::Ptr copy() const override;
134 void copy(const Metadata& other) override;
135 std::string str() const override;
136 bool asBool() const override;
137 Index32 size() const override { return static_cast<Index32>(sizeof(T)); }
138
139 /// Set this metadata's value.
140 void setValue(const T&);
141 /// Return this metadata's value.
142 T& value();
143 const T& value() const;
144
145 // Static specialized function for the type name. This function must be
146 // template specialized for each type T.
147 static Name staticTypeName() { return typeNameAsString<T>(); }
148
149 /// Create new metadata of this type.
150 static Metadata::Ptr createMetadata();
151
152 static void registerType();
153 static void unregisterType();
154 static bool isRegisteredType();
155
156protected:
157 void readValue(std::istream&, Index32 numBytes) override;
158 void writeValue(std::ostream&) const override;
159
160private:
161 T mValue;
162};
163
164/// Write a Metadata to an output stream
165std::ostream& operator<<(std::ostream& ostr, const Metadata& metadata);
166
167
168////////////////////////////////////////
169
170
171inline void
172Metadata::writeSize(std::ostream& os) const
173{
174 const Index32 n = this->size();
175 os.write(reinterpret_cast<const char*>(&n), sizeof(Index32));
176}
177
178
179inline Index32
180Metadata::readSize(std::istream& is)
181{
182 Index32 n = 0;
183 is.read(reinterpret_cast<char*>(&n), sizeof(Index32));
184 return n;
185}
186
187
188inline void
189Metadata::read(std::istream& is)
190{
191 const Index32 numBytes = this->readSize(is);
192 this->readValue(is, numBytes);
193}
194
195
196inline void
197Metadata::write(std::ostream& os) const
198{
199 this->writeSize(os);
200 this->writeValue(os);
201}
202
203
204////////////////////////////////////////
205
206
207template <typename T>
208inline
209TypedMetadata<T>::TypedMetadata() : mValue(T())
210{
211}
212
213template <typename T>
214inline
215 TypedMetadata<T>::TypedMetadata(const T &value) : mValue(value)
216{
217}
218
219template <typename T>
220inline
221 TypedMetadata<T>::TypedMetadata(const TypedMetadata<T> &other) :
222 Metadata(),
223 mValue(other.mValue)
224{
225}
226
227template <typename T>
228inline
229TypedMetadata<T>::~TypedMetadata()
230{
231}
232
233template <typename T>
234inline Name
235TypedMetadata<T>::typeName() const
236{
237 return TypedMetadata<T>::staticTypeName();
238}
239
240template <typename T>
241inline void
242TypedMetadata<T>::setValue(const T& val)
243{
244 mValue = val;
245}
246
247template <typename T>
248inline T&
249TypedMetadata<T>::value()
250{
251 return mValue;
252}
253
254template <typename T>
255inline const T&
256 TypedMetadata<T>::value() const
257{
258 return mValue;
259}
260
261template <typename T>
262inline Metadata::Ptr
263TypedMetadata<T>::copy() const
264{
265 Metadata::Ptr metadata(new TypedMetadata<T>());
266 metadata->copy(*this);
267 return metadata;
268}
269
270template <typename T>
271inline void
272 TypedMetadata<T>::copy(const Metadata &other)
273{
274 const TypedMetadata<T>* t = dynamic_cast<const TypedMetadata<T>*>(&other);
275 if (t == nullptr) OPENVDB_THROW(TypeError, "Incompatible type during copy");
276 mValue = t->mValue;
277}
278
279
280template<typename T>
281inline void
282TypedMetadata<T>::readValue(std::istream& is, Index32 /*numBytes*/)
283{
284 //assert(this->size() == numBytes);
285 is.read(reinterpret_cast<char*>(&mValue), this->size());
286}
287
288template<typename T>
289inline void
290TypedMetadata<T>::writeValue(std::ostream& os) const
291{
292 os.write(reinterpret_cast<const char*>(&mValue), this->size());
293}
294
295template <typename T>
296inline std::string
297TypedMetadata<T>::str() const
298{
299 std::ostringstream ostr;
300 ostr << mValue;
301 return ostr.str();
302}
303
304template<typename T>
305inline bool
306TypedMetadata<T>::asBool() const
307{
308 return !math::isZero(mValue);
309}
310
311template <typename T>
312inline Metadata::Ptr
313TypedMetadata<T>::createMetadata()
314{
315 Metadata::Ptr ret(new TypedMetadata<T>());
316 return ret;
317}
318
319template <typename T>
320inline void
321TypedMetadata<T>::registerType()
322{
323 Metadata::registerType(TypedMetadata<T>::staticTypeName(),
324 TypedMetadata<T>::createMetadata);
325}
326
327template <typename T>
328inline void
329TypedMetadata<T>::unregisterType()
330{
331 Metadata::unregisterType(TypedMetadata<T>::staticTypeName());
332}
333
334template <typename T>
335inline bool
336TypedMetadata<T>::isRegisteredType()
337{
338 return Metadata::isRegisteredType(TypedMetadata<T>::staticTypeName());
339}
340
341
342template<>
343inline std::string
344 TypedMetadata<bool>::str() const
345{
346 return (mValue ? "true" : "false");
347}
348
349
350 inline std::ostream&
351 operator<<(std::ostream& ostr, const Metadata& metadata)
352{
353 ostr << metadata.str();
354 return ostr;
355}
356
357
358 using BoolMetadata = TypedMetadata<bool>;
359 using DoubleMetadata = TypedMetadata<double>;
360 using FloatMetadata = TypedMetadata<float>;
361 using Int32Metadata = TypedMetadata<int32_t>;
362 using Int64Metadata = TypedMetadata<int64_t>;
363 using StringMetadata = TypedMetadata<std::string>;
364 using Vec2DMetadata = TypedMetadata<Vec2d>;
365 using Vec2IMetadata = TypedMetadata<Vec2i>;
366 using Vec2SMetadata = TypedMetadata<Vec2s>;
367 using Vec3DMetadata = TypedMetadata<Vec3d>;
368 using Vec3IMetadata = TypedMetadata<Vec3i>;
369 using Vec3SMetadata = TypedMetadata<Vec3s>;
370 using Vec4DMetadata = TypedMetadata<Vec4d>;
371 using Vec4IMetadata = TypedMetadata<Vec4i>;
372 using Vec4SMetadata = TypedMetadata<Vec4s>;
373 using Mat4SMetadata = TypedMetadata<Mat4s>;
374 using Mat4DMetadata = TypedMetadata<Mat4d>;
375
376
377////////////////////////////////////////
378
379
380template<>
381inline Index32
382 StringMetadata::size() const
383{
384 return static_cast<Index32>(mValue.size());
385}
386
387
388template<>
389inline std::string
390 StringMetadata::str() const
391{
392 return mValue;
393}
394
395
396template<>
397inline void
398 StringMetadata::readValue(std::istream& is, Index32 size)
399{
400 mValue.resize(size, '\0');
401 is.read(&mValue[0], size);
402}
403
404template<>
405inline void
406 StringMetadata::writeValue(std::ostream& os) const
407{
408 os.write(reinterpret_cast<const char*>(&mValue[0]), this->size());
409}
410
411} // namespace OPENVDB_VERSION_NAME
412} // namespace openvdb
413
414#endif // OPENVDB_METADATA_HAS_BEEN_INCLUDED
value
ValueT value
Definition: GridBuilder.h:1290
Math.h
General-purpose arithmetic and comparison routines, most of which accept arbitrary value types (or at...
Name.h
OPENVDB_API
#define OPENVDB_API
Definition: Platform.h:251
Exceptions.h
OpenVDB AX Exceptions.
Types.h
Consolidated llvm types for most supported types.
openvdb::v10_0::Metadata
Base class for storing metadata information in a grid.
Definition: Metadata.h:24
openvdb::v10_0::Metadata::ConstPtr
SharedPtr< const Metadata > ConstPtr
Definition: Metadata.h:27
openvdb::v10_0::Metadata::copy
virtual void copy(const Metadata &other)=0
Copy the given metadata into this metadata.
openvdb::v10_0::Metadata::operator!=
bool operator!=(const Metadata &other) const
Return true if the given metadata is different from this metadata.
Definition: Metadata.h:55
openvdb::v10_0::Metadata::asBool
virtual bool asBool() const =0
openvdb::v10_0::Metadata::typeName
virtual Name typeName() const =0
Return the type name of the metadata.
openvdb::v10_0::Metadata::Metadata
Metadata()
Definition: Metadata.h:29
openvdb::v10_0::Metadata::operator=
Metadata & operator=(const Metadata &)=delete
openvdb::v10_0::Metadata::Metadata
Metadata(const Metadata &)=delete
openvdb::v10_0::Metadata::write
void write(std::ostream &) const
Serialize this metadata to a stream.
Definition: Metadata.h:197
openvdb::v10_0::Metadata::createMetadata
static Metadata::Ptr createMetadata(const Name &typeName)
Create new metadata of the given type.
openvdb::v10_0::Metadata::writeValue
virtual void writeValue(std::ostream &) const =0
Write the metadata to a stream.
openvdb::v10_0::Metadata::str
virtual std::string str() const =0
Return a textual representation of this metadata.
openvdb::v10_0::Metadata::registerType
static void registerType(const Name &typeName, Metadata::Ptr(*createMetadata)())
Register the given metadata type along with a factory function.
openvdb::v10_0::Metadata::read
void read(std::istream &)
Unserialize this metadata from a stream.
Definition: Metadata.h:189
openvdb::v10_0::Metadata::isRegisteredType
static bool isRegisteredType(const Name &typeName)
Return true if the given type is known by the metadata type registry.
openvdb::v10_0::Metadata::copy
virtual Metadata::Ptr copy() const =0
Return a copy of the metadata.
openvdb::v10_0::Metadata::unregisterType
static void unregisterType(const Name &typeName)
openvdb::v10_0::Metadata::readSize
static Index32 readSize(std::istream &)
Read the size of the metadata from a stream.
Definition: Metadata.h:180
openvdb::v10_0::Metadata::operator==
bool operator==(const Metadata &other) const
Return true if the given metadata is equivalent to this metadata.
openvdb::v10_0::Metadata::Ptr
SharedPtr< Metadata > Ptr
Definition: Metadata.h:26
openvdb::v10_0::Metadata::clearRegistry
static void clearRegistry()
Clear out the metadata registry.
openvdb::v10_0::Metadata::writeSize
void writeSize(std::ostream &) const
Write the size of the metadata to a stream.
Definition: Metadata.h:172
openvdb::v10_0::Metadata::size
virtual Index32 size() const =0
Return the size of this metadata in bytes.
openvdb::v10_0::Metadata::readValue
virtual void readValue(std::istream &, Index32 numBytes)=0
Read the metadata from a stream.
openvdb::v10_0::Metadata::~Metadata
virtual ~Metadata()
Definition: Metadata.h:30
openvdb::v10_0::TypeError
Definition: Exceptions.h:64
openvdb::v10_0::TypedMetadata
Templated metadata class to hold specific types.
Definition: Metadata.h:122
openvdb::v10_0::TypedMetadata::size
Index32 size() const override
Return the size of this metadata in bytes.
Definition: Metadata.h:137
openvdb::v10_0::TypedMetadata::str
std::string str() const override
Return a textual representation of this metadata.
Definition: Metadata.h:297
openvdb::v10_0::TypedMetadata::asBool
bool asBool() const override
Definition: Metadata.h:306
openvdb::v10_0::TypedMetadata::typeName
Name typeName() const override
Return the type name of the metadata.
Definition: Metadata.h:235
openvdb::v10_0::TypedMetadata::registerType
static void registerType()
Definition: Metadata.h:321
openvdb::v10_0::TypedMetadata::unregisterType
static void unregisterType()
Definition: Metadata.h:329
openvdb::v10_0::TypedMetadata::isRegisteredType
static bool isRegisteredType()
Definition: Metadata.h:336
openvdb::v10_0::TypedMetadata::createMetadata
static Metadata::Ptr createMetadata()
Create new metadata of this type.
Definition: Metadata.h:313
openvdb::v10_0::TypedMetadata::TypedMetadata
TypedMetadata()
Definition: Metadata.h:209
openvdb::v10_0::TypedMetadata::~TypedMetadata
~TypedMetadata() override
Definition: Metadata.h:229
openvdb::v10_0::TypedMetadata::writeValue
void writeValue(std::ostream &) const override
Write the metadata to a stream.
Definition: Metadata.h:290
openvdb::v10_0::TypedMetadata::copy
Metadata::Ptr copy() const override
Return a copy of the metadata.
Definition: Metadata.h:263
openvdb::v10_0::TypedMetadata::value
T & value()
Return this metadata's value.
Definition: Metadata.h:249
openvdb::v10_0::TypedMetadata::staticTypeName
static Name staticTypeName()
Definition: Metadata.h:147
openvdb::v10_0::TypedMetadata::readValue
void readValue(std::istream &, Index32 numBytes) override
Read the metadata from a stream.
Definition: Metadata.h:282
openvdb::v10_0::TypedMetadata::setValue
void setValue(const T &)
Set this metadata's value.
Definition: Metadata.h:242
openvdb::v10_0::UnknownMetadata
Subclass to hold raw data of an unregistered type.
Definition: Metadata.h:93
openvdb::v10_0::UnknownMetadata::setValue
void setValue(const ByteVec &bytes)
Definition: Metadata.h:106
openvdb::v10_0::UnknownMetadata::size
Index32 size() const override
Return the size of this metadata in bytes.
Definition: Metadata.h:104
openvdb::v10_0::UnknownMetadata::copy
void copy(const Metadata &) override
Copy the given metadata into this metadata.
openvdb::v10_0::UnknownMetadata::value
const ByteVec & value() const
Definition: Metadata.h:107
openvdb::v10_0::UnknownMetadata::str
std::string str() const override
Return a textual representation of this metadata.
Definition: Metadata.h:102
openvdb::v10_0::UnknownMetadata::asBool
bool asBool() const override
Definition: Metadata.h:103
openvdb::v10_0::UnknownMetadata::typeName
Name typeName() const override
Return the type name of the metadata.
Definition: Metadata.h:99
openvdb::v10_0::UnknownMetadata::ByteVec
std::vector< uint8_t > ByteVec
Definition: Metadata.h:95
openvdb::v10_0::UnknownMetadata::writeValue
void writeValue(std::ostream &) const override
Write the metadata to a stream.
openvdb::v10_0::UnknownMetadata::copy
Metadata::Ptr copy() const override
Return a copy of the metadata.
openvdb::v10_0::UnknownMetadata::UnknownMetadata
UnknownMetadata(const Name &typ="<unknown>")
Definition: Metadata.h:97
openvdb::v10_0::UnknownMetadata::readValue
void readValue(std::istream &, Index32 numBytes) override
Read the metadata from a stream.
nanovdb::io::Internal::read
static void read(std::istream &is, GridHandle< BufferT > &handle, Codec codec)
nanovdb::io::Internal::write
static fileSize_t write(std::ostream &os, const GridHandle< BufferT > &handle, Codec codec)
openvdb::v10_0::math::isZero
bool isZero(const Type &x)
Return true if x is exactly equal to zero.
Definition: Math.h:337
openvdb::v10_0::Name
std::string Name
Definition: Name.h:17
openvdb::v10_0::operator<<
std::ostream & operator<<(std::ostream &ostr, const Metadata &metadata)
Write a Metadata to an output stream.
Definition: Metadata.h:351
openvdb::v10_0::Index32
uint32_t Index32
Definition: Types.h:52
openvdb::v10_0::SharedPtr
std::shared_ptr< T > SharedPtr
Definition: Types.h:114
openvdb
Definition: Exceptions.h:13
OPENVDB_THROW
#define OPENVDB_THROW(exception, message)
Definition: Exceptions.h:74
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h.in:121
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h.in:212