annotate OrthancStone/Sources/Oracle/OracleCommandBase.h @ 2124:16c01cc201e7

updated copyright, as Osimis is not active on Orthanc anymore
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 30 May 2024 17:00:29 +0200
parents c23eef785569
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Stone of Orthanc
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
2124
16c01cc201e7 updated copyright, as Osimis is not active on Orthanc anymore
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2114
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
2114
c23eef785569 update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2077
diff changeset
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
1598
8563ea5d8ae4 relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1596
diff changeset
9 * modify it under the terms of the GNU Lesser General Public License
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * as published by the Free Software Foundation, either version 3 of
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * the License, or (at your option) any later version.
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
1598
8563ea5d8ae4 relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1596
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8563ea5d8ae4 relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1596
diff changeset
16 * Lesser General Public License for more details.
1596
4fb8fdf03314 removed annoying whitespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
17 *
1598
8563ea5d8ae4 relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1596
diff changeset
18 * You should have received a copy of the GNU Lesser General Public
8563ea5d8ae4 relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1596
diff changeset
19 * License along with this program. If not, see
8563ea5d8ae4 relicensing some files, cf. osimis bm26 and chu agreement on 2020-05-20
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1596
diff changeset
20 * <http://www.gnu.org/licenses/>.
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include "IOracleCommand.h"
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
1455
30deba7bc8e2 simplifying include_directories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1300
diff changeset
28 #include <Compatibility.h>
30deba7bc8e2 simplifying include_directories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1300
diff changeset
29 #include <IDynamicObject.h>
1299
c38c89684d83 replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1279
diff changeset
30
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 #include <memory>
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 namespace OrthancStone
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
1128
8e3763d1736a removing CustomOracleCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 796
diff changeset
35 class OracleCommandBase : public IOracleCommand
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 private:
1299
c38c89684d83 replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1279
diff changeset
38 std::unique_ptr<Orthanc::IDynamicObject> payload_;
1831
a03260db8835 Added SetCallerName to IOracleCommand to ease debugging
Benjamin Golinvaux <bgo@osimis.io>
parents: 1739
diff changeset
39 std::string callerName_;
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 public:
1135
a0a33e5ea5bb IOracleCommand::Clone()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1128
diff changeset
42 void AcquirePayload(Orthanc::IDynamicObject* payload);
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
1128
8e3763d1736a removing CustomOracleCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 796
diff changeset
44 virtual bool HasPayload() const
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 return (payload_.get() != NULL);
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 }
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
1128
8e3763d1736a removing CustomOracleCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 796
diff changeset
49 virtual Orthanc::IDynamicObject& GetPayload() const;
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
1851
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
51 void SetCallerName(const std::string& callerName)
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
52 {
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
53 callerName_ = callerName;
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
54 }
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
55
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
56 virtual std::string GetCallerName() const ORTHANC_OVERRIDE
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
57 {
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
58 return callerName_;
739a69562826 cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1831
diff changeset
59 }
1831
a03260db8835 Added SetCallerName to IOracleCommand to ease debugging
Benjamin Golinvaux <bgo@osimis.io>
parents: 1739
diff changeset
60
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 Orthanc::IDynamicObject* ReleasePayload();
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 };
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 }