Mercurial > hg > orthanc
annotate OrthancServer/ServerJobs/ArchiveJob.h @ 2812:ea7aea6f6a95
improved naming of methods in IJob
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 06 Sep 2018 16:23:40 +0200 |
| parents | 7cfc8d266f41 |
| children | 9c0b0a6d8b54 |
| rev | line source |
|---|---|
| 2632 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2018 Osimis S.A., Belgium | |
| 6 * | |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU General Public License as | |
| 9 * published by the Free Software Foundation, either version 3 of the | |
| 10 * License, or (at your option) any later version. | |
| 11 * | |
| 12 * In addition, as a special exception, the copyright holders of this | |
| 13 * program give permission to link the code of its release with the | |
| 14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 15 * that use the same license as the "OpenSSL" library), and distribute | |
| 16 * the linked executables. You must obey the GNU General Public License | |
| 17 * in all respects for all of the code used other than "OpenSSL". If you | |
| 18 * modify file(s) with this exception, you may extend this exception to | |
| 19 * your version of the file(s), but you are not obligated to do so. If | |
| 20 * you do not wish to do so, delete this exception statement from your | |
| 21 * version. If you delete this exception statement from all source files | |
| 22 * in the program, then also delete it here. | |
| 23 * | |
| 24 * This program is distributed in the hope that it will be useful, but | |
| 25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 27 * General Public License for more details. | |
| 28 * | |
| 29 * You should have received a copy of the GNU General Public License | |
| 30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 31 **/ | |
| 32 | |
| 33 | |
| 34 #pragma once | |
| 35 | |
| 36 #include "../../Core/JobsEngine/IJob.h" | |
| 37 #include "../../Core/TemporaryFile.h" | |
| 38 #include "../ServerContext.h" | |
| 39 | |
| 40 namespace Orthanc | |
| 41 { | |
| 42 class ArchiveJob : public IJob | |
| 43 { | |
| 44 private: | |
| 45 class ArchiveIndex; | |
| 46 class ArchiveIndexVisitor; | |
| 47 class IArchiveVisitor; | |
| 48 class MediaIndexVisitor; | |
| 49 class ResourceIdentifiers; | |
| 50 class ZipCommands; | |
| 51 class ZipWriterIterator; | |
| 52 | |
| 2730 | 53 boost::shared_ptr<TemporaryFile> target_; |
| 54 ServerContext& context_; | |
| 55 boost::shared_ptr<ArchiveIndex> archive_; | |
| 56 bool isMedia_; | |
| 57 bool enableExtendedSopClass_; | |
| 58 std::string description_; | |
| 2632 | 59 |
| 2730 | 60 boost::shared_ptr<ZipWriterIterator> writer_; |
| 61 size_t currentStep_; | |
| 62 unsigned int instancesCount_; | |
| 63 uint64_t uncompressedSize_; | |
| 2632 | 64 |
| 65 public: | |
| 66 ArchiveJob(boost::shared_ptr<TemporaryFile>& target, | |
| 67 ServerContext& context, | |
| 68 bool isMedia, | |
| 69 bool enableExtendedSopClass); | |
| 70 | |
| 71 void SetDescription(const std::string& description) | |
| 72 { | |
| 73 description_ = description; | |
| 74 } | |
| 75 | |
| 76 const std::string& GetDescription() const | |
| 77 { | |
| 78 return description_; | |
| 79 } | |
| 80 | |
| 81 void AddResource(const std::string& publicId); | |
| 82 | |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
83 virtual void Reset(); |
| 2632 | 84 |
| 85 virtual void Start(); | |
| 86 | |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
87 virtual JobStepResult Step(); |
| 2632 | 88 |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
89 virtual void Stop(JobStopReason reason) |
| 2632 | 90 { |
| 91 } | |
| 92 | |
| 93 virtual float GetProgress(); | |
| 94 | |
| 95 virtual void GetJobType(std::string& target); | |
| 96 | |
| 97 virtual void GetPublicContent(Json::Value& value); | |
| 98 | |
|
2663
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
99 virtual bool Serialize(Json::Value& value) |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
100 { |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
101 return false; // Cannot serialize this kind of job |
|
228e2783ce83
some jobs might not be serializable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
102 } |
| 2632 | 103 }; |
| 104 } |