MeVisLab Toolbox Reference
mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h
Go to the documentation of this file.
1// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2// **InsertLicense** code
3//----------------------------------------------------------------------------------
4//
5// NOTE:
6// This file has been generated automatically by
7// FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/convertDcmtkToML.py
8// using the template file
9// FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/MLDcmtkAccessoriesNew/templates/DcmSequenceInterface.h
10//
11// Destination project:
12// FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessoriesNew/DcmSequenceInterfaces
13//
14//----------------------------------------------------------------------------------
16
21//----------------------------------------------------------------------------------
22
23#ifndef __mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface_H
24#define __mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface_H
25
26// Local includes
27#include "mlDcmtkAccessories.h"
28
29// Dcmtk includes
30//#include "mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface.h" //DRTReferencedReferenceImageSequenceInRTBeamsModule
31
32
33// ML includes
34#ifndef __mlModuleIncludes_H
35#include "mlModuleIncludes.h"
36#endif
37
39
40// ------------------------------------------------------------------
42// ------------------------------------------------------------------
44{
45 public:
46
48 {
49 public:
50
51 Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
52
54
55 Item(const Item &copyDcmItem) : _dcmItem(copyDcmItem.getTreePtr()) {}
56
57 Item &operator=(const Item &copyDcmItem){ _dcmItem = copyDcmItem.getTreePtr(); return *this; }
58
59 virtual ~Item() {}
60
61 DCMTree::TreePtr getTreePtr() const { return _dcmItem; }
62
63 bool isValid() const { return _dcmItem.get() != nullptr; }
64
65
66 // EndCumulativeMetersetWeight (300c,0009) vr=DS, vm=1, type=3
67 bool getEndCumulativeMetersetWeight(std::string& parameter) const;
68 std::string getEndCumulativeMetersetWeightTag() const { return "(300c,0009)"; }
69 bool setEndCumulativeMetersetWeight(std::string parameter);
70
71 // ReferenceImageNumber (300a,00c8) vr=IS, vm=1, type=1C
72 bool getReferenceImageNumber(std::string& parameter) const;
73 std::string getReferenceImageNumberTag() const { return "(300a,00c8)"; }
74 bool setReferenceImageNumber(std::string parameter);
75
76 // ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1C
77 bool getReferencedSOPClassUID(std::string& parameter) const;
78 std::string getReferencedSOPClassUIDTag() const { return "(0008,1150)"; }
79 bool setReferencedSOPClassUID(std::string parameter);
80
81 // ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1C
82 bool getReferencedSOPInstanceUID(std::string& parameter) const;
83 std::string getReferencedSOPInstanceUIDTag() const { return "(0008,1155)"; }
84 bool setReferencedSOPInstanceUID(std::string parameter);
85
86 // StartCumulativeMetersetWeight (300c,0008) vr=DS, vm=1, type=3
87 bool getStartCumulativeMetersetWeight(std::string& parameter) const;
88 std::string getStartCumulativeMetersetWeightTag() const { return "(300c,0008)"; }
89 bool setStartCumulativeMetersetWeight(std::string parameter);
90
91
92 private:
93
94 DCMTree::TreePtr _dcmItem;
95
96 };
97
99
101 DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface(std::vector<DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
102
109
112 // EndCumulativeMetersetWeight (300c,0009) vr=DS, vm=1, type=3
113 bool getEndCumulativeMetersetWeight(unsigned long idx, std::string& parameter) const;
114 bool getEndCumulativeMetersetWeight(DCMTree::TreePtr item, std::string& parameter) const;
115 std::string getEndCumulativeMetersetWeightTag() const { return "(300c,0009)"; }
116 bool setEndCumulativeMetersetWeight(unsigned long idx, std::string parameter);
117
118 // ReferenceImageNumber (300a,00c8) vr=IS, vm=1, type=1C
119 bool getReferenceImageNumber(unsigned long idx, std::string& parameter) const;
120 bool getReferenceImageNumber(DCMTree::TreePtr item, std::string& parameter) const;
121 std::string getReferenceImageNumberTag() const { return "(300a,00c8)"; }
122 bool setReferenceImageNumber(unsigned long idx, std::string parameter);
123
124 // ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1C
125 bool getReferencedSOPClassUID(unsigned long idx, std::string& parameter) const;
126 bool getReferencedSOPClassUID(DCMTree::TreePtr item, std::string& parameter) const;
127 std::string getReferencedSOPClassUIDTag() const { return "(0008,1150)"; }
128 bool setReferencedSOPClassUID(unsigned long idx, std::string parameter);
129
130 // ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1C
131 bool getReferencedSOPInstanceUID(unsigned long idx, std::string& parameter) const;
132 bool getReferencedSOPInstanceUID(DCMTree::TreePtr item, std::string& parameter) const;
133 std::string getReferencedSOPInstanceUIDTag() const { return "(0008,1155)"; }
134 bool setReferencedSOPInstanceUID(unsigned long idx, std::string parameter);
135
136 // StartCumulativeMetersetWeight (300c,0008) vr=DS, vm=1, type=3
137 bool getStartCumulativeMetersetWeight(unsigned long idx, std::string& parameter) const;
138 bool getStartCumulativeMetersetWeight(DCMTree::TreePtr item, std::string& parameter) const;
139 std::string getStartCumulativeMetersetWeightTag() const { return "(300c,0008)"; }
140 bool setStartCumulativeMetersetWeight(unsigned long idx, std::string parameter);
141
142
145 void setSequence(std::vector<DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item> dcmSequence) {
146 _itemVec = dcmSequence;
147 }
148
151 std::vector<DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item> getSequence() const {
152 return _itemVec;
153 }
154
157 bool hasSequence() const {
158 return (_itemVec.size() != 0);
159 }
160
164 return static_cast<MLint>(_itemVec.size());
165 }
166
170 if (_itemVec.size() > idx) {
171 return _itemVec[idx];
172 }
174 }
175
182
186
189 bool insertItem(const size_t idx) {
190 if (_itemVec.size() > idx) {
191 std::vector<DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item>::iterator it = _itemVec.begin();
192 std::advance(it, idx);
194 return true;
195 }
196 return false;
197 }
198
201 bool removeItem(const size_t idx) {
202 if ( _itemVec.size() > idx ) {
203 std::vector<DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item>::iterator it = _itemVec.begin();
204 std::advance(it, idx);
205 _itemVec.erase(it);
206 return true;
207 }
208 return false;
209 }
210
211 protected:
213 std::vector<DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item> _itemVec;
214};
215
217
218#endif // __mlDcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface_H
219
220/* MeVis-Hidden-Components-Start */
221/* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface(std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item > dcmSequence)
Default Constructor.
bool getReferencedSOPInstanceUID(DCMTree::TreePtr item, std::string &parameter) const
bool setStartCumulativeMetersetWeight(unsigned long idx, std::string parameter)
bool getEndCumulativeMetersetWeight(unsigned long idx, std::string &parameter) const
bool getReferenceImageNumber(unsigned long idx, std::string &parameter) const
bool getEndCumulativeMetersetWeight(DCMTree::TreePtr item, std::string &parameter) const
bool setReferencedSOPInstanceUID(unsigned long idx, std::string parameter)
bool setEndCumulativeMetersetWeight(unsigned long idx, std::string parameter)
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool getStartCumulativeMetersetWeight(DCMTree::TreePtr item, std::string &parameter) const
bool getReferencedSOPClassUID(unsigned long idx, std::string &parameter) const
void addItem(DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item newItem)
std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
bool getStartCumulativeMetersetWeight(unsigned long idx, std::string &parameter) const
DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item & addItem()
Adds a new item to the sequence.
void setSequence(std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item > dcmSequence)
Set the DRTReferencedReferenceImageSequenceInRTBeamsModule this interface class provides access to.
bool hasSequence() const
Check if the DRTReferencedReferenceImageSequenceInRTBeamsModule is set.
bool setReferencedSOPClassUID(unsigned long idx, std::string parameter)
bool getReferenceImageNumber(DCMTree::TreePtr item, std::string &parameter) const
bool getReferencedSOPClassUID(DCMTree::TreePtr item, std::string &parameter) const
bool getReferencedSOPInstanceUID(unsigned long idx, std::string &parameter) const
bool setReferenceImageNumber(unsigned long idx, std::string parameter)
std::vector< DcmDRTReferencedReferenceImageSequenceInRTBeamsModuleInterface::Item > getSequence() const
Return the DRTReferencedReferenceImageSequenceInRTBeamsModule this interface class provides access to...
Class collecting some DICOM helper functionality explicitly for dcmtk.
Target mlrange_cast(Source arg)
Generic version of checked ML casts.
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition mlTypeDefs.h:490
std::vector< TreePtr > TreePtrVector
a vector of TreePtr - used for sequences
Definition DCMTree_Lib.h:85
boost::shared_ptr< Tree > TreePtr
shared pointer to a DCMTree::Tree
Definition DCMTree_Lib.h:72