annotate OrthancStone/Sources/Oracle/OracleCommandBase.h @ 1831:a03260db8835

Added SetCallerName to IOracleCommand to ease debugging and logging
author Benjamin Golinvaux <bgo@osimis.io>
date Thu, 03 Jun 2021 09:14:07 +0200
parents 9ac2a65d4172
children 739a69562826
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
1739
9ac2a65d4172 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1598
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * 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
8 * modify it under the terms of the GNU Lesser General Public License
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * 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
14 * 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
15 * Lesser General Public License for more details.
1596
4fb8fdf03314 removed annoying whitespace
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1512
diff changeset
16 *
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
17 * 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
18 * 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
19 * <http://www.gnu.org/licenses/>.
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
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 #pragma once
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "IOracleCommand.h"
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
1455
30deba7bc8e2 simplifying include_directories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1300
diff changeset
27 #include <Compatibility.h>
30deba7bc8e2 simplifying include_directories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1300
diff changeset
28 #include <IDynamicObject.h>
1299
c38c89684d83 replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1279
diff changeset
29
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 #include <memory>
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 namespace OrthancStone
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
1128
8e3763d1736a removing CustomOracleCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 796
diff changeset
34 class OracleCommandBase : public IOracleCommand
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
1299
c38c89684d83 replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1279
diff changeset
37 std::unique_ptr<Orthanc::IDynamicObject> payload_;
1831
a03260db8835 Added SetCallerName to IOracleCommand to ease debugging
Benjamin Golinvaux <bgo@osimis.io>
parents: 1739
diff changeset
38 std::string callerName_;
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 public:
1135
a0a33e5ea5bb IOracleCommand::Clone()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1128
diff changeset
41 void AcquirePayload(Orthanc::IDynamicObject* payload);
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
1128
8e3763d1736a removing CustomOracleCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 796
diff changeset
43 virtual bool HasPayload() const
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 return (payload_.get() != NULL);
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 }
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
1128
8e3763d1736a removing CustomOracleCommand
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 796
diff changeset
48 virtual Orthanc::IDynamicObject& GetPayload() const;
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
1831
a03260db8835 Added SetCallerName to IOracleCommand to ease debugging
Benjamin Golinvaux <bgo@osimis.io>
parents: 1739
diff changeset
50 void SetCallerName(const std::string callerName) { callerName_ = callerName; }
a03260db8835 Added SetCallerName to IOracleCommand to ease debugging
Benjamin Golinvaux <bgo@osimis.io>
parents: 1739
diff changeset
51 virtual std::string GetCallerName() const { return callerName_; }
a03260db8835 Added SetCallerName to IOracleCommand to ease debugging
Benjamin Golinvaux <bgo@osimis.io>
parents: 1739
diff changeset
52
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 Orthanc::IDynamicObject* ReleasePayload();
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 };
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 }