OpenVDB 13.0.0

Loading...
Searching...
No Matches
MetaMap.h
Go to the documentation of this file.
1// Copyright Contributors to the OpenVDB Project
2// SPDX-License-Identifier: Apache-2.0
3
4#ifndef OPENVDB_METADATA_METAMAP_HAS_BEEN_INCLUDED
5#define OPENVDB_METADATA_METAMAP_HAS_BEEN_INCLUDED
6
7#include "Metadata.h"
8#include "Types.h"
9#include "Exceptions.h"
10#include <iosfwd>
11#include <map>
12
13
14 namespace openvdb {
15 OPENVDB_USE_VERSION_NAMESPACE
16 namespace OPENVDB_VERSION_NAME {
17
18/// Container that maps names (strings) to values of arbitrary types
19 class OPENVDB_API MetaMap
20{
21 public:
22 using Ptr = SharedPtr<MetaMap>;
23 using ConstPtr = SharedPtr<const MetaMap>;
24
25 using MetadataMap = std::map<Name, Metadata::Ptr>;
26 using MetaIterator = MetadataMap::iterator;
27 using ConstMetaIterator = MetadataMap::const_iterator;
28 ///< @todo this should really iterate over a map of Metadata::ConstPtrs
29
30 MetaMap() {}
31 MetaMap(const MetaMap& other);
32 virtual ~MetaMap() {}
33
34 /// Return a copy of this map whose fields are shared with this map.
35 MetaMap::Ptr copyMeta() const;
36 /// Return a deep copy of this map that shares no data with this map.
37 MetaMap::Ptr deepCopyMeta() const;
38
39 /// Assign a deep copy of another map to this map.
40 MetaMap& operator=(const MetaMap&);
41
42 /// Unserialize metadata from the given stream.
43 void readMeta(std::istream&);
44 /// Serialize metadata to the given stream.
45 void writeMeta(std::ostream&) const;
46
47 /// @brief Insert a new metadata field or overwrite the value of an existing field.
48 /// @details If a field with the given name doesn't already exist, add a new field.
49 /// Otherwise, if the new value's type is the same as the existing field's value type,
50 /// overwrite the existing value with new value.
51 /// @throw TypeError if a field with the given name already exists, but its value type
52 /// is not the same as the new value's
53 /// @throw ValueError if the given field name is empty.
54 void insertMeta(const Name&, const Metadata& value);
55 /// @brief Deep copy all of the metadata fields from the given map into this map.
56 /// @throw TypeError if any field in the given map has the same name as
57 /// but a different value type than one of this map's fields.
58 void insertMeta(const MetaMap&);
59
60 /// Remove the given metadata field if it exists.
61 void removeMeta(const Name&);
62
63 //@{
64 /// @brief Return a pointer to the metadata with the given name.
65 /// If no such field exists, return a null pointer.
66 Metadata::Ptr operator[](const Name&);
67 Metadata::ConstPtr operator[](const Name&) const;
68 //@}
69
70 //@{
71 /// @brief Return a pointer to a TypedMetadata object of type @c T and with the given name.
72 /// If no such field exists or if there is a type mismatch, return a null pointer.
73 template<typename T> typename T::Ptr getMetadata(const Name&);
74 template<typename T> typename T::ConstPtr getMetadata(const Name&) const;
75 //@}
76
77 /// @brief Return a reference to the value of type @c T stored in the given metadata field.
78 /// @throw LookupError if no field with the given name exists.
79 /// @throw TypeError if the given field is not of type @c T.
80 template<typename T> T& metaValue(const Name&);
81 template<typename T> const T& metaValue(const Name&) const;
82
83 // Functions for iterating over the metadata
84 MetaIterator beginMeta() { return mMeta.begin(); }
85 MetaIterator endMeta() { return mMeta.end(); }
86 ConstMetaIterator beginMeta() const { return mMeta.begin(); }
87 ConstMetaIterator endMeta() const { return mMeta.end(); }
88
89 void clearMetadata() { mMeta.clear(); }
90
91 size_t metaCount() const { return mMeta.size(); }
92
93 /// Return a string describing this metadata map. Prefix each line with @a indent.
94 std::string str(const std::string& indent = "") const;
95
96 /// Return @c true if the given map is equivalent to this map.
97 bool operator==(const MetaMap& other) const;
98 /// Return @c true if the given map is different from this map.
99 bool operator!=(const MetaMap& other) const { return !(*this == other); }
100
101 private:
102 /// @brief Return a pointer to TypedMetadata with the given template parameter.
103 /// @throw LookupError if no field with the given name is found.
104 /// @throw TypeError if the given field is not of type T.
105 template<typename T>
106 typename TypedMetadata<T>::Ptr getValidTypedMetadata(const Name&) const;
107
108 MetadataMap mMeta;
109};
110
111/// Write a MetaMap to an output stream
112std::ostream& operator<<(std::ostream&, const MetaMap&);
113
114
115////////////////////////////////////////
116
117
118 inline Metadata::Ptr
119 MetaMap::operator[](const Name& name)
120{
121 MetaIterator iter = mMeta.find(name);
122 return (iter == mMeta.end() ? Metadata::Ptr() : iter->second);
123}
124
125 inline Metadata::ConstPtr
126 MetaMap::operator[](const Name &name) const
127{
128 ConstMetaIterator iter = mMeta.find(name);
129 return (iter == mMeta.end() ? Metadata::Ptr() : iter->second);
130}
131
132
133////////////////////////////////////////
134
135
136 template<typename T>
137 inline typename T::Ptr
138 MetaMap::getMetadata(const Name &name)
139{
140 ConstMetaIterator iter = mMeta.find(name);
141 if (iter == mMeta.end()) return typename T::Ptr{};
142
143 // To ensure that we get valid conversion if the metadata pointers cross dso
144 // boundaries, we have to check the qualified typename and then do a static
145 // cast. This is slower than doing a dynamic_pointer_cast, but is safer when
146 // pointers cross dso boundaries.
147 if (iter->second->typeName() == T::staticTypeName()) {
148 return StaticPtrCast<T, Metadata>(iter->second);
149 } // else
150 return typename T::Ptr{};
151}
152
153 template<typename T>
154 inline typename T::ConstPtr
155 MetaMap::getMetadata(const Name &name) const
156{
157 ConstMetaIterator iter = mMeta.find(name);
158 if (iter == mMeta.end()) return typename T::ConstPtr{};
159
160 // To ensure that we get valid conversion if the metadata pointers cross dso
161 // boundaries, we have to check the qualified typename and then do a static
162 // cast. This is slower than doing a dynamic_pointer_cast, but is safer when
163 // pointers cross dso boundaries.
164 if (iter->second->typeName() == T::staticTypeName()) {
165 return StaticPtrCast<const T, const Metadata>(iter->second);
166 } // else
167 return typename T::ConstPtr{};
168}
169
170
171////////////////////////////////////////
172
173
174 template<typename T>
175 inline typename TypedMetadata<T>::Ptr
176MetaMap::getValidTypedMetadata(const Name &name) const
177{
178 ConstMetaIterator iter = mMeta.find(name);
179 if (iter == mMeta.end()) OPENVDB_THROW(LookupError, "Cannot find metadata " << name);
180
181 // To ensure that we get valid conversion if the metadata pointers cross dso
182 // boundaries, we have to check the qualified typename and then do a static
183 // cast. This is slower than doing a dynamic_pointer_cast, but is safer when
184 // pointers cross dso boundaries.
185 typename TypedMetadata<T>::Ptr m;
186 if (iter->second->typeName() == TypedMetadata<T>::staticTypeName()) {
187 m = StaticPtrCast<TypedMetadata<T>, Metadata>(iter->second);
188 }
189 if (!m) OPENVDB_THROW(TypeError, "Invalid type for metadata " << name);
190 return m;
191}
192
193
194////////////////////////////////////////
195
196
197 template<typename T>
198 inline T&
199 MetaMap::metaValue(const Name &name)
200{
201 typename TypedMetadata<T>::Ptr m = getValidTypedMetadata<T>(name);
202 return m->value();
203}
204
205
206 template<typename T>
207 inline const T&
208 MetaMap::metaValue(const Name &name) const
209{
210 typename TypedMetadata<T>::Ptr m = getValidTypedMetadata<T>(name);
211 return m->value();
212}
213
214} // namespace OPENVDB_VERSION_NAME
215} // namespace openvdb
216
217#endif // OPENVDB_METADATA_METAMAP_HAS_BEEN_INCLUDED
Metadata.h
OPENVDB_API
#define OPENVDB_API
Definition Platform.h:291
openvdb::v13_0::LookupError
Definition Exceptions.h:60
openvdb::v13_0::MetaMap
Container that maps names (strings) to values of arbitrary types.
Definition MetaMap.h:20
openvdb::v13_0::MetaMap::str
std::string str(const std::string &indent="") const
Return a string describing this metadata map. Prefix each line with indent.
openvdb::v13_0::MetaMap::copyMeta
MetaMap::Ptr copyMeta() const
Return a copy of this map whose fields are shared with this map.
openvdb::v13_0::MetaMap::operator!=
bool operator!=(const MetaMap &other) const
Return true if the given map is different from this map.
Definition MetaMap.h:99
openvdb::v13_0::MetaMap::ConstPtr
SharedPtr< const MetaMap > ConstPtr
Definition MetaMap.h:23
openvdb::v13_0::MetaMap::deepCopyMeta
MetaMap::Ptr deepCopyMeta() const
Return a deep copy of this map that shares no data with this map.
openvdb::v13_0::MetaMap::getMetadata
T::Ptr getMetadata(const Name &)
Return a pointer to a TypedMetadata object of type T and with the given name. If no such field exists...
Definition MetaMap.h:138
openvdb::v13_0::MetaMap::operator[]
Metadata::Ptr operator[](const Name &)
Return a pointer to the metadata with the given name. If no such field exists, return a null pointer.
Definition MetaMap.h:119
openvdb::v13_0::MetaMap::beginMeta
ConstMetaIterator beginMeta() const
Definition MetaMap.h:86
openvdb::v13_0::MetaMap::MetaIterator
MetadataMap::iterator MetaIterator
Definition MetaMap.h:26
openvdb::v13_0::MetaMap::getMetadata
T::ConstPtr getMetadata(const Name &) const
Definition MetaMap.h:155
openvdb::v13_0::MetaMap::MetadataMap
std::map< Name, Metadata::Ptr > MetadataMap
Definition MetaMap.h:25
openvdb::v13_0::MetaMap::metaValue
T & metaValue(const Name &)
Return a reference to the value of type T stored in the given metadata field.
Definition MetaMap.h:199
openvdb::v13_0::MetaMap::metaValue
const T & metaValue(const Name &) const
Definition MetaMap.h:208
openvdb::v13_0::MetaMap::readMeta
void readMeta(std::istream &)
Unserialize metadata from the given stream.
openvdb::v13_0::MetaMap::operator[]
Metadata::ConstPtr operator[](const Name &) const
Definition MetaMap.h:126
openvdb::v13_0::MetaMap::endMeta
ConstMetaIterator endMeta() const
Definition MetaMap.h:87
openvdb::v13_0::MetaMap::metaCount
size_t metaCount() const
Definition MetaMap.h:91
openvdb::v13_0::MetaMap::clearMetadata
void clearMetadata()
Definition MetaMap.h:89
openvdb::v13_0::MetaMap::MetaMap
MetaMap(const MetaMap &other)
openvdb::v13_0::MetaMap::beginMeta
MetaIterator beginMeta()
Definition MetaMap.h:84
openvdb::v13_0::MetaMap::ConstMetaIterator
MetadataMap::const_iterator ConstMetaIterator
Definition MetaMap.h:27
openvdb::v13_0::MetaMap::writeMeta
void writeMeta(std::ostream &) const
Serialize metadata to the given stream.
openvdb::v13_0::MetaMap::removeMeta
void removeMeta(const Name &)
Remove the given metadata field if it exists.
openvdb::v13_0::MetaMap::Ptr
SharedPtr< MetaMap > Ptr
Definition MetaMap.h:22
openvdb::v13_0::MetaMap::insertMeta
void insertMeta(const MetaMap &)
Deep copy all of the metadata fields from the given map into this map.
openvdb::v13_0::MetaMap::endMeta
MetaIterator endMeta()
Definition MetaMap.h:85
openvdb::v13_0::MetaMap::operator==
bool operator==(const MetaMap &other) const
Return true if the given map is equivalent to this map.
openvdb::v13_0::MetaMap::~MetaMap
virtual ~MetaMap()
Definition MetaMap.h:32
openvdb::v13_0::MetaMap::operator=
MetaMap & operator=(const MetaMap &)
Assign a deep copy of another map to this map.
openvdb::v13_0::MetaMap::MetaMap
MetaMap()
Definition MetaMap.h:30
openvdb::v13_0::MetaMap::insertMeta
void insertMeta(const Name &, const Metadata &value)
Insert a new metadata field or overwrite the value of an existing field.
openvdb::v13_0::Metadata
Base class for storing metadata information in a grid.
Definition Metadata.h:25
openvdb::v13_0::Metadata::ConstPtr
SharedPtr< const Metadata > ConstPtr
Definition Metadata.h:28
openvdb::v13_0::Metadata::Ptr
SharedPtr< Metadata > Ptr
Definition Metadata.h:27
openvdb::v13_0::TypeError
Definition Exceptions.h:64
openvdb::v13_0::TypedMetadata::Ptr
SharedPtr< TypedMetadata< T > > Ptr
Definition Metadata.h:125
openvdb::v13_0::TypedMetadata::value
T & value()
Return this metadata's value.
Definition Metadata.h:250
openvdb::v13_0::TypedMetadata::staticTypeName
static Name staticTypeName()
Definition Metadata.h:148
openvdb::v13_0::Name
std::string Name
Definition Name.h:19
openvdb::v13_0::operator<<
std::ostream & operator<<(std::ostream &ostr, const Metadata &metadata)
Write a Metadata to an output stream.
Definition Metadata.h:352
openvdb::v13_0::SharedPtr
std::shared_ptr< T > SharedPtr
Definition Types.h:95
openvdb::v13_0::StaticPtrCast
SharedPtr< T > StaticPtrCast(const SharedPtr< U > &ptr)
Return a new shared pointer that points to the same object as the given pointer after a static_cast.
Definition Types.h:127
openvdb
Definition Exceptions.h:13
Exceptions.h
OPENVDB_THROW
#define OPENVDB_THROW(exception, message)
Definition Exceptions.h:74
Types.h
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:218