annotate Core/IDynamicObject.h @ 3434:6503ab9489ba

fix
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 18 Jun 2019 11:37:18 +0200
parents 4e43e67f8ecf
children 94f4a18a79cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
139
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
4 * Department, University Hospital of Liege, Belgium
3060
4e43e67f8ecf preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2989
diff changeset
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
139
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include <boost/noncopyable.hpp>
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 namespace Orthanc
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 /**
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 * This class should be the ancestor to any class whose type is
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 * determined at the runtime, and that can be dynamically allocated.
140
4d863c7b2f44 message queues
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
43 * Being a child of IDynamicObject only implies the existence of a
4d863c7b2f44 message queues
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 139
diff changeset
44 * virtual destructor.
139
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 **/
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 class IDynamicObject : public boost::noncopyable
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 public:
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 virtual ~IDynamicObject()
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 {
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 }
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 };
2989
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
53
2858
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
54
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
55 /**
2989
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
56 * This class is a simple implementation of a IDynamicObject that
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
57 * stores a single typed value.
2858
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
58 */
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
59 template <typename T>
2989
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
60 class SingleValueObject : public IDynamicObject
2858
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
61 {
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
62 private:
2989
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
63 T value_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
64
2858
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
65 public:
2989
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
66 explicit SingleValueObject(const T& value) :
2858
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
67 value_(value)
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
68 {
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
69 }
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
70
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
71 const T& GetValue() const
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
72 {
2989
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2858
diff changeset
73 return value_;
2858
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
74 }
39b171502059 added SingleValueObject: a simple implementation of a IDynamicObject that stores a single typed value
am@osimis.io
parents: 2447
diff changeset
75 };
139
3ad78369fcc4 start threaded messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 }