annotate Core/ICommand.h @ 2447:878b59270859

upgrade to year 2018
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Jan 2018 09:35:07 +0100
parents a3a65de1840f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
84966299c8f8 ThreadedCommandProcessor
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
2447
878b59270859 upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
84966299c8f8 ThreadedCommandProcessor
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
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "IDynamicObject.h"
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 namespace Orthanc
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 /**
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 * This class is the base class for the "Command" design pattern.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 * http://en.wikipedia.org/wiki/Command_pattern
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 **/
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 class ICommand : public IDynamicObject
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 public:
466
9da3596069b8 handling failed commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 458
diff changeset
47 virtual bool Execute() = 0;
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 };
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 }