1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkMetaDataDictionary_h
#define itkMetaDataDictionary_h
#include "itkMetaDataObjectBase.h"
#include <algorithm> // For std::equal
#include <vector>
#include <map>
#include <string>
#include <memory>
namespace itk
{
/** \class MetaDataDictionary
* \brief Provides a mechanism for storing a collection of arbitrary
* data types
*
* \author Hans J. Johnson
*
* The MetaDataDictionary, along with the MetaDataObject derived template
* classes, is designed to provide a mechanism for storing a collection of
* arbitrary data types. The main motivation for such a collection is to
* associate arbitrary data elements with itk DataObjects.
*
* The MetaDataDictionary implements shallow copying with copy on
* write behavior. When a copy of this class is created, the new copy
* will be shared with the old copy via C++11 shared pointers. When a
* non-constant operation is done, if the dictionary is not unique to
* this object, then a deep copy is performed. This make is very cheap
* to create multiple copies of the same dictionary if they are never
* modified.
*
* \ingroup ITKCommon
* \sphinx
* \sphinxexample{Core/Common/StoreNonPixelDataInImage,Store Non-Pixel Data In Image}
* \endsphinx
*/
class ITKCommon_EXPORT MetaDataDictionary
{
public:
using Self = MetaDataDictionary;
/**
* Defines the default behavior for printing out this element
* \param os An output stream
*/
virtual void
Print(std::ostream & os) const;
// Declare the datastructure that will be used to hold the
// dictionary.
using MetaDataDictionaryMapType = std::map<std::string, MetaDataObjectBase::Pointer>;
using Iterator = MetaDataDictionaryMapType::iterator;
using ConstIterator = MetaDataDictionaryMapType::const_iterator;
// Constructor
MetaDataDictionary();
// Copy Constructor
MetaDataDictionary(const MetaDataDictionary &);
MetaDataDictionary(MetaDataDictionary &&) = default;
// operator =
MetaDataDictionary &
operator=(const MetaDataDictionary &);
MetaDataDictionary &
operator=(MetaDataDictionary &&) = default;
// Destructor
virtual ~MetaDataDictionary();
/** Returns (metaDataDictionary1 == metaDataDictionary2). */
friend bool
operator==(const Self & lhs, const Self & rhs)
{
using KeyValuePair = MetaDataDictionaryMapType::value_type;
return (lhs.m_Dictionary == rhs.m_Dictionary) ||
((lhs.m_Dictionary != nullptr) && (rhs.m_Dictionary != nullptr) &&
(lhs.m_Dictionary->size() == rhs.m_Dictionary->size()) &&
std::equal(lhs.m_Dictionary->cbegin(),
lhs.m_Dictionary->cend(),
rhs.m_Dictionary->cbegin(),
[](const KeyValuePair & keyValuePair1, const KeyValuePair & keyValuePair2) {
const auto & value1 = keyValuePair1.second;
const auto & value2 = keyValuePair2.second;
return (keyValuePair1.first == keyValuePair2.first) &&
((value1 == value2) ||
((value1 != nullptr) && (value2 != nullptr) && (*value1 == *value2)));
}));
}
/** Returns (metaDataDictionary1 != metaDataDictionary2). */
friend bool
operator!=(const Self & lhs, const Self & rhs)
{
return !(lhs == rhs);
}
/** Returns a vector of keys to the key/value entries in the
* dictionary. Iterate through the dictionary using these keys.
*/
std::vector<std::string>
GetKeys() const;
// Implement map's api. On some Microsoft compilers, stl containers
// cannot be exported. This causes problems when building DLL's.
// Here we inherit privately from std::map and provide a simple
// API. The implementation will be in the DLL.
MetaDataObjectBase::Pointer & operator[](const std::string &);
// \brief Get a constant point to a DataObject
//
// If the key does not exist then nullptr is returned.
const MetaDataObjectBase * operator[](const std::string &) const;
const MetaDataObjectBase *
Get(const std::string &) const;
void
Set(const std::string &, MetaDataObjectBase *);
bool
HasKey(const std::string &) const;
bool
Erase(const std::string &);
/** \warning the following functions SHOULD NOT be used with
* the visual studio 6 compiler since iterator outside of the dll
* context cannot be dereferenced safely */
/** Returns an iterator to the beginning of the map */
// Blacklisted by igenerator.py
Iterator
Begin();
// Blacklisted by igenerator.py
ConstIterator
Begin() const;
/** Returns an iterator to the end of the map */
// Blacklisted by igenerator.py
Iterator
End();
// Blacklisted by igenerator.py
ConstIterator
End() const;
/** Returns an iterator matching the string key */
Iterator
Find(const std::string & key);
ConstIterator
Find(const std::string & key) const;
/** remove all MetaObjects from dictionary */
void
Clear();
void
Swap(MetaDataDictionary & other);
private:
bool
MakeUnique();
std::shared_ptr<MetaDataDictionaryMapType> m_Dictionary{};
};
inline void
swap(MetaDataDictionary & a, MetaDataDictionary & b)
{
a.Swap(b);
}
} // namespace itk
#endif // itkMetaDataDictionary_h
|
