MeVisLab Toolbox Reference
mlDcmDRTToleranceTableSequenceInterface.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 __mlDcmDRTToleranceTableSequenceInterface_H
24#define __mlDcmDRTToleranceTableSequenceInterface_H
25
26// Local includes
27#include "mlDcmtkAccessories.h"
28
29// Dcmtk includes
30//#include "mlDcmDRTToleranceTableSequenceInterface.h" //DRTToleranceTableSequence
31#include "mlDcmDRTBeamLimitingDeviceToleranceSequenceInterface.h" //DRTBeamLimitingDeviceToleranceSequence
32
33
34// ML includes
35#ifndef __mlModuleIncludes_H
36#include "mlModuleIncludes.h"
37#endif
38
40
41// ------------------------------------------------------------------
43// ------------------------------------------------------------------
45{
46 public:
47
49 {
50 public:
51
52 Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
53
55
56 Item(const Item &copyDcmItem) : _dcmItem(copyDcmItem.getTreePtr()) {}
57
58 Item &operator=(const Item &copyDcmItem){ _dcmItem = copyDcmItem.getTreePtr(); return *this; }
59
60 virtual ~Item() {}
61
62 DCMTree::TreePtr getTreePtr() const { return _dcmItem; }
63
64 bool isValid() const { return _dcmItem.get() != nullptr; }
65
66
67 // BeamLimitingDeviceAngleTolerance (300a,0046) vr=DS, vm=1, type=3
68 bool getBeamLimitingDeviceAngleTolerance(std::string& parameter) const;
69 std::string getBeamLimitingDeviceAngleToleranceTag() const { return "(300a,0046)"; }
70 bool setBeamLimitingDeviceAngleTolerance(std::string parameter);
71
72 // GantryAngleTolerance (300a,0044) vr=DS, vm=1, type=3
73 bool getGantryAngleTolerance(std::string& parameter) const;
74 std::string getGantryAngleToleranceTag() const { return "(300a,0044)"; }
75 bool setGantryAngleTolerance(std::string parameter);
76
77 // GantryPitchAngleTolerance (300a,014e) vr=FL, vm=1, type=3
78 bool getGantryPitchAngleTolerance(float& parameter) const;
79 std::string getGantryPitchAngleToleranceTag() const { return "(300a,014e)"; }
80 bool setGantryPitchAngleTolerance(float parameter);
81
82 // PatientSupportAngleTolerance (300a,004c) vr=DS, vm=1, type=3
83 bool getPatientSupportAngleTolerance(std::string& parameter) const;
84 std::string getPatientSupportAngleToleranceTag() const { return "(300a,004c)"; }
85 bool setPatientSupportAngleTolerance(std::string parameter);
86
87 // TableTopEccentricAngleTolerance (300a,004e) vr=DS, vm=1, type=3
88 bool getTableTopEccentricAngleTolerance(std::string& parameter) const;
89 std::string getTableTopEccentricAngleToleranceTag() const { return "(300a,004e)"; }
90 bool setTableTopEccentricAngleTolerance(std::string parameter);
91
92 // TableTopLateralPositionTolerance (300a,0053) vr=DS, vm=1, type=3
93 bool getTableTopLateralPositionTolerance(std::string& parameter) const;
94 std::string getTableTopLateralPositionToleranceTag() const { return "(300a,0053)"; }
95 bool setTableTopLateralPositionTolerance(std::string parameter);
96
97 // TableTopLongitudinalPositionTolerance (300a,0052) vr=DS, vm=1, type=3
98 bool getTableTopLongitudinalPositionTolerance(std::string& parameter) const;
99 std::string getTableTopLongitudinalPositionToleranceTag() const { return "(300a,0052)"; }
100 bool setTableTopLongitudinalPositionTolerance(std::string parameter);
101
102 // TableTopVerticalPositionTolerance (300a,0051) vr=DS, vm=1, type=3
103 bool getTableTopVerticalPositionTolerance(std::string& parameter) const;
104 std::string getTableTopVerticalPositionToleranceTag() const { return "(300a,0051)"; }
105 bool setTableTopVerticalPositionTolerance(std::string parameter);
106
107 // ToleranceTableLabel (300a,0043) vr=SH, vm=1, type=3
108 bool getToleranceTableLabel(std::string& parameter) const;
109 std::string getToleranceTableLabelTag() const { return "(300a,0043)"; }
110 bool setToleranceTableLabel(std::string parameter);
111
112 // ToleranceTableNumber (300a,0042) vr=IS, vm=1, type=1C
113 bool getToleranceTableNumber(std::string& parameter) const;
114 std::string getToleranceTableNumberTag() const { return "(300a,0042)"; }
115 bool setToleranceTableNumber(std::string parameter);
116
117 // BeamLimitingDeviceToleranceSequence (300a,0048) vr=SQ, vm=1, type=3
119 std::string getBeamLimitingDeviceToleranceSequenceTag() const { return std::string("(300a,0048)"); }
121
122
123 private:
124
125 DCMTree::TreePtr _dcmItem;
126
127 };
128
130
132 DcmDRTToleranceTableSequenceInterface(std::vector<DcmDRTToleranceTableSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
133
140
143 // BeamLimitingDeviceAngleTolerance (300a,0046) vr=DS, vm=1, type=3
144 bool getBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string& parameter) const;
145 bool getBeamLimitingDeviceAngleTolerance(DCMTree::TreePtr item, std::string& parameter) const;
146 std::string getBeamLimitingDeviceAngleToleranceTag() const { return "(300a,0046)"; }
147 bool setBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string parameter);
148
149 // GantryAngleTolerance (300a,0044) vr=DS, vm=1, type=3
150 bool getGantryAngleTolerance(unsigned long idx, std::string& parameter) const;
151 bool getGantryAngleTolerance(DCMTree::TreePtr item, std::string& parameter) const;
152 std::string getGantryAngleToleranceTag() const { return "(300a,0044)"; }
153 bool setGantryAngleTolerance(unsigned long idx, std::string parameter);
154
155 // GantryPitchAngleTolerance (300a,014e) vr=FL, vm=1, type=3
156 bool getGantryPitchAngleTolerance(unsigned long idx, float& parameter) const;
158 std::string getGantryPitchAngleToleranceTag() const { return "(300a,014e)"; }
159 bool setGantryPitchAngleTolerance(unsigned long idx, float parameter);
160
161 // PatientSupportAngleTolerance (300a,004c) vr=DS, vm=1, type=3
162 bool getPatientSupportAngleTolerance(unsigned long idx, std::string& parameter) const;
163 bool getPatientSupportAngleTolerance(DCMTree::TreePtr item, std::string& parameter) const;
164 std::string getPatientSupportAngleToleranceTag() const { return "(300a,004c)"; }
165 bool setPatientSupportAngleTolerance(unsigned long idx, std::string parameter);
166
167 // TableTopEccentricAngleTolerance (300a,004e) vr=DS, vm=1, type=3
168 bool getTableTopEccentricAngleTolerance(unsigned long idx, std::string& parameter) const;
169 bool getTableTopEccentricAngleTolerance(DCMTree::TreePtr item, std::string& parameter) const;
170 std::string getTableTopEccentricAngleToleranceTag() const { return "(300a,004e)"; }
171 bool setTableTopEccentricAngleTolerance(unsigned long idx, std::string parameter);
172
173 // TableTopLateralPositionTolerance (300a,0053) vr=DS, vm=1, type=3
174 bool getTableTopLateralPositionTolerance(unsigned long idx, std::string& parameter) const;
175 bool getTableTopLateralPositionTolerance(DCMTree::TreePtr item, std::string& parameter) const;
176 std::string getTableTopLateralPositionToleranceTag() const { return "(300a,0053)"; }
177 bool setTableTopLateralPositionTolerance(unsigned long idx, std::string parameter);
178
179 // TableTopLongitudinalPositionTolerance (300a,0052) vr=DS, vm=1, type=3
180 bool getTableTopLongitudinalPositionTolerance(unsigned long idx, std::string& parameter) const;
182 std::string getTableTopLongitudinalPositionToleranceTag() const { return "(300a,0052)"; }
183 bool setTableTopLongitudinalPositionTolerance(unsigned long idx, std::string parameter);
184
185 // TableTopVerticalPositionTolerance (300a,0051) vr=DS, vm=1, type=3
186 bool getTableTopVerticalPositionTolerance(unsigned long idx, std::string& parameter) const;
187 bool getTableTopVerticalPositionTolerance(DCMTree::TreePtr item, std::string& parameter) const;
188 std::string getTableTopVerticalPositionToleranceTag() const { return "(300a,0051)"; }
189 bool setTableTopVerticalPositionTolerance(unsigned long idx, std::string parameter);
190
191 // ToleranceTableLabel (300a,0043) vr=SH, vm=1, type=3
192 bool getToleranceTableLabel(unsigned long idx, std::string& parameter) const;
193 bool getToleranceTableLabel(DCMTree::TreePtr item, std::string& parameter) const;
194 std::string getToleranceTableLabelTag() const { return "(300a,0043)"; }
195 bool setToleranceTableLabel(unsigned long idx, std::string parameter);
196
197 // ToleranceTableNumber (300a,0042) vr=IS, vm=1, type=1C
198 bool getToleranceTableNumber(unsigned long idx, std::string& parameter) const;
199 bool getToleranceTableNumber(DCMTree::TreePtr item, std::string& parameter) const;
200 std::string getToleranceTableNumberTag() const { return "(300a,0042)"; }
201 bool setToleranceTableNumber(unsigned long idx, std::string parameter);
202
203 // BeamLimitingDeviceToleranceSequence (300a,0048) vr=SQ, vm=1, type=3
205 std::string getBeamLimitingDeviceToleranceSequenceTag() const { return std::string("(300a,0048)"); }
207
208
211 void setSequence(std::vector<DcmDRTToleranceTableSequenceInterface::Item> dcmSequence) {
212 _itemVec = dcmSequence;
213 }
214
217 std::vector<DcmDRTToleranceTableSequenceInterface::Item> getSequence() const {
218 return _itemVec;
219 }
220
223 bool hasSequence() const {
224 return (_itemVec.size() != 0);
225 }
226
230 return static_cast<MLint>(_itemVec.size());
231 }
232
236 if (_itemVec.size() > idx) {
237 return _itemVec[idx];
238 }
240 }
241
246 return _itemVec[_itemVec.size()-1];
247 }
248
252
255 bool insertItem(const size_t idx) {
256 if (_itemVec.size() > idx) {
257 std::vector<DcmDRTToleranceTableSequenceInterface::Item>::iterator it = _itemVec.begin();
258 std::advance(it, idx);
260 return true;
261 }
262 return false;
263 }
264
267 bool removeItem(const size_t idx) {
268 if ( _itemVec.size() > idx ) {
269 std::vector<DcmDRTToleranceTableSequenceInterface::Item>::iterator it = _itemVec.begin();
270 std::advance(it, idx);
271 _itemVec.erase(it);
272 return true;
273 }
274 return false;
275 }
276
277 protected:
279 std::vector<DcmDRTToleranceTableSequenceInterface::Item> _itemVec;
280};
281
283
284#endif // __mlDcmDRTToleranceTableSequenceInterface_H
285
286/* MeVis-Hidden-Components-Start */
287/* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
Class to provide access to DRTBeamLimitingDeviceToleranceSequence.
bool setToleranceTableNumber(std::string parameter)
DcmDRTBeamLimitingDeviceToleranceSequenceInterface getBeamLimitingDeviceToleranceSequence() const
bool setToleranceTableLabel(std::string parameter)
bool setTableTopVerticalPositionTolerance(std::string parameter)
void setBeamLimitingDeviceToleranceSequence(DcmDRTBeamLimitingDeviceToleranceSequenceInterface seq)
bool getToleranceTableLabel(std::string &parameter) const
bool getGantryPitchAngleTolerance(float &parameter) const
bool getTableTopEccentricAngleTolerance(std::string &parameter) const
bool setPatientSupportAngleTolerance(std::string parameter)
bool setTableTopLongitudinalPositionTolerance(std::string parameter)
bool getTableTopLongitudinalPositionTolerance(std::string &parameter) const
bool getGantryAngleTolerance(std::string &parameter) const
bool getTableTopLateralPositionTolerance(std::string &parameter) const
bool setGantryAngleTolerance(std::string parameter)
bool setTableTopEccentricAngleTolerance(std::string parameter)
bool getToleranceTableNumber(std::string &parameter) const
bool getBeamLimitingDeviceAngleTolerance(std::string &parameter) const
bool getPatientSupportAngleTolerance(std::string &parameter) const
bool setTableTopLateralPositionTolerance(std::string parameter)
bool getTableTopVerticalPositionTolerance(std::string &parameter) const
bool setBeamLimitingDeviceAngleTolerance(std::string parameter)
Class to provide access to DRTToleranceTableSequence.
bool setBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string parameter)
bool getTableTopVerticalPositionTolerance(unsigned long idx, std::string &parameter) const
DcmDRTToleranceTableSequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool getToleranceTableLabel(DCMTree::TreePtr item, std::string &parameter) const
DcmDRTToleranceTableSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
void setSequence(std::vector< DcmDRTToleranceTableSequenceInterface::Item > dcmSequence)
Set the DRTToleranceTableSequence this interface class provides access to.
bool getTableTopVerticalPositionTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool getPatientSupportAngleTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool getGantryPitchAngleTolerance(unsigned long idx, float &parameter) const
bool getBeamLimitingDeviceAngleTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool getGantryAngleTolerance(unsigned long idx, std::string &parameter) const
bool setGantryAngleTolerance(unsigned long idx, std::string parameter)
bool getToleranceTableLabel(unsigned long idx, std::string &parameter) const
bool setTableTopLateralPositionTolerance(unsigned long idx, std::string parameter)
bool getBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string &parameter) const
std::vector< DcmDRTToleranceTableSequenceInterface::Item > getSequence() const
Return the DRTToleranceTableSequence this interface class provides access to.
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
bool getToleranceTableNumber(DCMTree::TreePtr item, std::string &parameter) const
virtual ~DcmDRTToleranceTableSequenceInterface()
Default virtual Destructor.
bool getTableTopLateralPositionTolerance(unsigned long idx, std::string &parameter) const
bool hasSequence() const
Check if the DRTToleranceTableSequence is set.
void addItem(DcmDRTToleranceTableSequenceInterface::Item newItem)
bool getTableTopLongitudinalPositionTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool removeItem(const size_t idx)
Removes the indicated item from the sequence.
DcmDRTToleranceTableSequenceInterface(std::vector< DcmDRTToleranceTableSequenceInterface::Item > dcmSequence)
Default Constructor.
bool getTableTopEccentricAngleTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool setGantryPitchAngleTolerance(unsigned long idx, float parameter)
bool setToleranceTableNumber(unsigned long idx, std::string parameter)
bool setPatientSupportAngleTolerance(unsigned long idx, std::string parameter)
std::vector< DcmDRTToleranceTableSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
bool getTableTopEccentricAngleTolerance(unsigned long idx, std::string &parameter) const
bool setTableTopLongitudinalPositionTolerance(unsigned long idx, std::string parameter)
void setBeamLimitingDeviceToleranceSequence(DcmDRTBeamLimitingDeviceToleranceSequenceInterface seq, unsigned long idx)
bool getGantryPitchAngleTolerance(DCMTree::TreePtr item, float &parameter) const
bool getToleranceTableNumber(unsigned long idx, std::string &parameter) const
bool setTableTopVerticalPositionTolerance(unsigned long idx, std::string parameter)
bool getGantryAngleTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool insertItem(const size_t idx)
Insert an item at the indicated position.
bool getTableTopLongitudinalPositionTolerance(unsigned long idx, std::string &parameter) const
bool setTableTopEccentricAngleTolerance(unsigned long idx, std::string parameter)
DcmDRTBeamLimitingDeviceToleranceSequenceInterface getBeamLimitingDeviceToleranceSequence(unsigned long idx) const
bool getPatientSupportAngleTolerance(unsigned long idx, std::string &parameter) const
bool setToleranceTableLabel(unsigned long idx, std::string parameter)
bool getTableTopLateralPositionTolerance(DCMTree::TreePtr item, std::string &parameter) const
Class to provide access to DRTBeamLimitingDeviceToleranceSequence.
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