File: AbstractPropertyContainerModel.h

package info (click to toggle)
itksnap 3.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 10,196 kB
  • ctags: 9,196
  • sloc: cpp: 62,895; sh: 175; makefile: 13
file content (360 lines) | stat: -rw-r--r-- 12,503 bytes parent folder | download | duplicates (2)
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
#ifndef ABSTRACTPROPERTYCONTAINERMODEL_H
#define ABSTRACTPROPERTYCONTAINERMODEL_H

#include "PropertyModel.h"
#include "Registry.h"

/**
 * A helper class for AbstractPropertyContainerModel. This is a typeless parent
 * for ConcretePropertyHolder.
 */
class ConcretePropertyHolderBase : public itk::Object
{
public:
  irisITKAbstractObjectMacro(ConcretePropertyHolderBase, itk::Object)

  virtual void DeepCopy(const ConcretePropertyHolderBase *source) = 0;
  virtual bool Equals(const ConcretePropertyHolderBase *other) = 0;
  virtual void Serialize(Registry &folder) const = 0;
  virtual void Deserialize(Registry &folder) = 0;
  virtual const itk::TimeStamp &GetPropertyTimeStamp() const = 0;
};

template <class TAtomic>
class DefaultRegistrySerializationTraits
{
public:
  void Serialize(RegistryValue &entry, const TAtomic &value) const
  {
    entry << value;
  }
  void Deserialize(RegistryValue &entry, TAtomic &value, const TAtomic &deflt) const
  {
    value = entry[deflt];
  }
};

template <class TAtomic>
class RegistryEnumSerializationTraits
{
public:
  typedef RegistryEnumMap<TAtomic> EnumMap;
  typedef RegistryEnumSerializationTraits<TAtomic> Self;

  RegistryEnumSerializationTraits() {}

  RegistryEnumSerializationTraits(const EnumMap &enummap)
    : m_EnumMap(enummap) {}

  RegistryEnumSerializationTraits(const Self &other)
    : m_EnumMap(other.m_EnumMap) {}

  void Serialize(RegistryValue &entry, const TAtomic &value) const
  {
    entry.PutEnum(m_EnumMap, value);
  }
  void Deserialize(RegistryValue &entry, TAtomic &value, const TAtomic &deflt) const
  {
    value = entry.GetEnum(m_EnumMap, deflt);
  }

private:
  EnumMap m_EnumMap;
};



/**
 * A helper class for AbstractPropertyContainerModel that holds a pointer to
 * a ConcretePointerModel and supports copy and serialization operations.
 */
template <class TAtomic, class TDomain, class TRegistryTraits>
class ConcretePropertyHolder : public ConcretePropertyHolderBase
{
public:
  // ITK stuff
  typedef ConcretePropertyHolder<TAtomic, TDomain, TRegistryTraits> Self;
  typedef ConcretePropertyHolderBase Superclass;
  typedef SmartPtr<Self> Pointer;
  typedef SmartPtr<const Self> ConstPointer;

  itkTypeMacro(ConcretePropertyHolder, ConcretePropertyHolderBase)
  itkNewMacro(Self)

  // Held property type
  typedef ConcretePropertyModel<TAtomic, TDomain> PropertyType;

  virtual void DeepCopy(const ConcretePropertyHolderBase *source)
  {
    const Self *source_cast = static_cast<const Self *>(source);
    PropertyType *source_prop = source_cast->m_Property;
    m_Property->DeepCopy(source_prop);
  }

  virtual bool Equals(const ConcretePropertyHolderBase *other)
  {
    const Self *source_cast = static_cast<const Self *>(other);
    PropertyType *source_prop = source_cast->m_Property;
    return m_Property->Equals(source_prop);
  }

  virtual void Serialize(Registry &folder) const
  {
    TAtomic value;
    if(m_Property->GetValueAndDomain(value, NULL))
      {
      m_Traits.Serialize(folder.Entry(m_RegistryKey), value);
      }
  }

  virtual void Deserialize(Registry &folder)
  {
    RegistryValue &rv = folder.Entry(m_RegistryKey);
    if(!rv.IsNull())
      {
      TAtomic value;
      m_Traits.Deserialize(rv, value, m_Property->GetValue());
      m_Property->SetValue(value);
      }
  }

  virtual const itk::TimeStamp &GetPropertyTimeStamp() const
  {
    return m_Property->GetTimeStamp();
  }


  irisGetSetMacro(Property, PropertyType *)
  irisGetSetMacro(RegistryKey, const std::string &)
  irisGetSetMacro(Traits, const TRegistryTraits &)

protected:

  // Pointer to the property
  SmartPtr<PropertyType> m_Property;

  // Registry key for serialization
  std::string m_RegistryKey;

  // A traits object for serialization
  TRegistryTraits m_Traits;
};


/**
 * This class is intended to serve as a parent class for models that hold
 * a (large) number of individual ConcretePropertyModel objects. For example,
 * we may want a FooSettings class that holds a bunch of properties that
 * influence the behavior of Foo. Normally, one would write a struct with
 * these different fields:
 *
 *   struct FooSettings {
 *     int FooWidth;
 *     double FooAspectRatio;
 *     bool IsFooable;
 *   }
 *
 * However, in the model/view paradigm in ITK-SNAP, we want each of the fields
 * to be represented by a PropertyModel so that observers can listen to changes
 * in the individual fields, and so that the fields can be hooked up to GUI
 * widgets. So instead, FooSettings is represented like this:
 *
 *    class FooSettingsModel : public AbstractModel
 *    {
 *    public:
 *      ...
 *      irisRangedPropertyAccessMacro(FooWidth, int)
 *      irisRangedPropertyAccessMacro(FooAspectRatio, double)
 *      irisSimplePropertyAccessMacro(IsFooable, bool)
 *    protected:
 *      ...
 *      SmartPtr<ConcreteRangedIntProperty> m_FooWidth;
 *      SmartPtr<ConcreteRangedDoubleProperty> m_FooAspectRatio;
 *      SmartPtr<ConcreteSimpleBooleanProperty> m_IsFooable;
 *    }
 *
 * However, this class does not automatically offer comparison operators or
 * means to copy the model (deep copy). Writing that code by hand is a pain,
 * especially when there are lots of fields. So this is where the class
 * AbstractPropertyContainerModel comes in. It allows the fields to be registered
 * in the constructor, and provides default implementations of the comparison
 * operators and DeepCopy function.
 *
 * The class AbstractPropertyContainerModel is a way to create a container of
 * heterogeneous property models that supports comparison, serialization, and
 * copy operations with little coding. The FooSettingsModel class will still have
 * a similar structure to the one above.
 *
 *    class FooSettingsModel : public AbstractPropertyContainerModel
 *    {
 *    public:
 *      ...
 *      irisRangedPropertyAccessMacro(FooWidth, int)
 *      irisRangedPropertyAccessMacro(FooAspectRatio, double)
 *      irisSimplePropertyAccessMacro(IsFooable, bool)
 *    protected:
 *      ...
 *      SmartPtr<ConcreteRangedIntProperty> m_FooWidth;
 *      SmartPtr<ConcreteRangedDoubleProperty> m_FooAspectRatio;
 *      SmartPtr<ConcreteSimpleBooleanProperty> m_IsFooable;
 *    }
 *
 * The difference is that in the constructor, when the properties are created
 * using the NewSimpleProperty/NewRangedProperty methods, they are automatically
 * added to an internal list, allowing comparison, copy, and serialization.
 *
 *    FooSettingsModel::FooSettingsModel
 *    {
 *      m_FooWidth = NewRangedProperty("FooWidth", 2, 0, 4, 1);
 *      m_FooAspectRatio = NewSimpleProperty("FooAspectRatio", 0.25, 0.0, 1.0, 0.01);
 *      m_IsFooable = NewSimpleProperty("FooWidth", true);
 *    }
 */
class AbstractPropertyContainerModel : public AbstractModel
{
public:
  irisITKObjectMacro(AbstractPropertyContainerModel, AbstractModel)

  FIRES(ChildPropertyChangedEvent)

  void DeepCopy(const AbstractPropertyContainerModel *source);

  virtual bool operator == (const AbstractPropertyContainerModel &source);

  virtual bool operator != (const AbstractPropertyContainerModel &source);

  /** Return this objects modified time. This will return the latest of our
   * own modified time and the modified times of all the children */
  virtual unsigned long GetMTime() const;

  virtual const itk::TimeStamp &GetTimeStamp() const;

  void WriteToRegistry(Registry &folder) const;

  void ReadFromRegistry(Registry &folder);

protected:

  // Register a child model with this class. This should be called in the
  // constructor when the model is created. The model should be a concrete
  // property model. This method should only be called in the constructor
  template <class TAtomic, class TDomain>
  SmartPtr< ConcretePropertyModel<TAtomic, TDomain> >
  RegisterProperty(const std::string &key,
                   SmartPtr< ConcretePropertyModel<TAtomic, TDomain> > model)
  {
    typedef DefaultRegistrySerializationTraits<TAtomic> RegTraits;
    typedef ConcretePropertyHolder<TAtomic, TDomain, RegTraits> HolderType;
    SmartPtr<HolderType> holder = HolderType::New();
    holder->SetProperty(model);
    holder->SetRegistryKey(key);
	m_Properties.insert(std::make_pair((std::string)key, (HolderPointer)holder));

    // Propagate the modification events from the property
    Rebroadcast(model, ValueChangedEvent(), ChildPropertyChangedEvent());
    Rebroadcast(model, DomainChangedEvent(), ChildPropertyChangedEvent());

    return model;
  }

  // Register a child model with an enum atomic type. The third parameter is
  // the enum-to-string mapping used to serialize the enum.
  template <class TAtomic, class TDomain>
  SmartPtr< ConcretePropertyModel<TAtomic, TDomain> >
  RegisterEnumProperty(const std::string &key,
                       SmartPtr< ConcretePropertyModel<TAtomic, TDomain> > model,
                       const RegistryEnumMap<TAtomic> &enummap)
  {
    typedef RegistryEnumSerializationTraits<TAtomic> RegTraits;
    RegTraits traits(enummap);

    typedef ConcretePropertyHolder<TAtomic, TDomain, RegTraits> HolderType;
    SmartPtr<HolderType> holder = HolderType::New();
    holder->SetProperty(model);
    holder->SetRegistryKey(key);
    holder->SetTraits(traits);

	m_Properties.insert(std::make_pair((std::string)key, (HolderPointer)holder));

    // Propagate the modification events from the property
    Rebroadcast(model, ValueChangedEvent(), ChildPropertyChangedEvent());
    Rebroadcast(model, DomainChangedEvent(), ChildPropertyChangedEvent());

    return model;
  }

  // A convenience method that creates a new simple concrete property and
  // then registers it using RegisterModel
  template <class TAtomic>
  SmartPtr< ConcretePropertyModel<TAtomic, TrivialDomain> >
  NewSimpleProperty(const std::string &key, const TAtomic &value)
  {
    return RegisterProperty(key, NewSimpleConcreteProperty(value));
  }

  // A convenience method that creates a new simple concrete property and
  // then registers it using RegisterModel
  template <class TAtomic>
  SmartPtr< ConcretePropertyModel<TAtomic, NumericValueRange<TAtomic> > >
  NewRangedProperty(const std::string &key,
                    const TAtomic &value,
                    const TAtomic &minval,
                    const TAtomic &maxval,
                    const TAtomic &step)
  {
    return RegisterProperty(key, NewRangedConcreteProperty(value, minval, maxval, step));
  }

  // A convenience method that creates a new simple concrete property and
  // then registers it using RegisterModel
  template <class TAtomic>
  SmartPtr< ConcretePropertyModel<TAtomic, TrivialDomain> >
  NewSimpleEnumProperty(const std::string &key, const TAtomic &value,
                        const RegistryEnumMap<TAtomic> &enummap)
  {
    return RegisterEnumProperty(key, NewSimpleConcreteProperty(value), enummap);
  }

private:

  // The storage for the fields
  typedef SmartPtr<ConcretePropertyHolderBase> HolderPointer;
  typedef std::map<std::string, HolderPointer> PropertyMap;
  typedef PropertyMap::iterator PropertyMapIter;
  typedef PropertyMap::const_iterator PropertyMapCIter;

  PropertyMap m_Properties;

};

/*
 * These typedefs are commented out because I felt that they made the code too
 * hard to read. They can reduce coding, but can sow confusion.
 *
#define apcmRangedPropertyAccessMacro(name,type) \
  virtual AbstractPropertyModel<type, NumericValueRange<type> > * Get##name##Model () const \
    { return GetProperty<type, NumericValueRange<type> >("##name##"); } \
  virtual void Set##name (type _arg) \
    { this->Get##name##Model()->SetValue(_arg); } \
  virtual type Get##name () const \
    { return this->Get##name##Model()->GetValue(); }

#define apcmSimplePropertyAccessMacro(name,type) \
  virtual AbstractPropertyModel<type, TrivialDomain > * Get##name##Model () const \
    { return GetProperty<type, TrivialDomain >("##name##"); } \
  virtual void Set##name (type _arg) \
    { this->Get##name##Model()->SetValue(_arg); } \
  virtual type Get##name () const \
    { return this->Get##name##Model()->GetValue(); }

#define apcmGenericPropertyAccessMacro(name,type,domaintype) \
  virtual AbstractPropertyModel<type, domaintype > * Get##name##Model () const \
    { return GetProperty<type, domaintype >("##name##"); } \
  virtual void Set##name (type _arg) \
    { this->Get##name##Model()->SetValue(_arg); } \
  virtual type Get##name () const \
    { return this->Get##name##Model()->GetValue(); }
*/


#endif // ABSTRACTPROPERTYCONTAINERMODEL_H