MeVisLab Toolbox Reference
mlDcmDRTIonToleranceTableSequenceInterface.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 __mlDcmDRTIonToleranceTableSequenceInterface_H
24 #define __mlDcmDRTIonToleranceTableSequenceInterface_H
25 
26 // Local includes
27 #include "mlDcmtkAccessories.h"
28 
29 // Dcmtk includes
30 //#include "mlDcmDRTIonToleranceTableSequenceInterface.h" //DRTIonToleranceTableSequence
31 #include "mlDcmDRTBeamLimitingDeviceToleranceSequenceInterface.h" //DRTBeamLimitingDeviceToleranceSequence
32 
33 
34 // ML includes
35 #ifndef __mlModuleIncludes_H
36 #include "mlModuleIncludes.h"
37 #endif
38 
39 ML_START_NAMESPACE
40 
41 // ------------------------------------------------------------------
43 // ------------------------------------------------------------------
45 {
46  public:
47 
49  {
50  public:
51 
52  Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
53 
54  Item(DCMTree::TreePtr dcmItem) : _dcmItem(dcmItem) {}
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  // PatientSupportAngleTolerance (300a,004c) vr=DS, vm=1, type=3
78  bool getPatientSupportAngleTolerance(std::string& parameter) const;
79  std::string getPatientSupportAngleToleranceTag() const { return "(300a,004c)"; }
80  bool setPatientSupportAngleTolerance(std::string parameter);
81 
82  // SnoutPositionTolerance (300a,004b) vr=FL, vm=1, type=3
83  bool getSnoutPositionTolerance(float& parameter) const;
84  std::string getSnoutPositionToleranceTag() const { return "(300a,004b)"; }
85  bool setSnoutPositionTolerance(float parameter);
86 
87  // TableTopLateralPositionTolerance (300a,0053) vr=DS, vm=1, type=3
88  bool getTableTopLateralPositionTolerance(std::string& parameter) const;
89  std::string getTableTopLateralPositionToleranceTag() const { return "(300a,0053)"; }
90  bool setTableTopLateralPositionTolerance(std::string parameter);
91 
92  // TableTopLongitudinalPositionTolerance (300a,0052) vr=DS, vm=1, type=3
93  bool getTableTopLongitudinalPositionTolerance(std::string& parameter) const;
94  std::string getTableTopLongitudinalPositionToleranceTag() const { return "(300a,0052)"; }
95  bool setTableTopLongitudinalPositionTolerance(std::string parameter);
96 
97  // TableTopPitchAngleTolerance (300a,004f) vr=FL, vm=1, type=3
98  bool getTableTopPitchAngleTolerance(float& parameter) const;
99  std::string getTableTopPitchAngleToleranceTag() const { return "(300a,004f)"; }
100  bool setTableTopPitchAngleTolerance(float parameter);
101 
102  // TableTopRollAngleTolerance (300a,0050) vr=FL, vm=1, type=3
103  bool getTableTopRollAngleTolerance(float& parameter) const;
104  std::string getTableTopRollAngleToleranceTag() const { return "(300a,0050)"; }
105  bool setTableTopRollAngleTolerance(float parameter);
106 
107  // TableTopVerticalPositionTolerance (300a,0051) vr=DS, vm=1, type=3
108  bool getTableTopVerticalPositionTolerance(std::string& parameter) const;
109  std::string getTableTopVerticalPositionToleranceTag() const { return "(300a,0051)"; }
110  bool setTableTopVerticalPositionTolerance(std::string parameter);
111 
112  // ToleranceTableLabel (300a,0043) vr=SH, vm=1, type=3
113  bool getToleranceTableLabel(std::string& parameter) const;
114  std::string getToleranceTableLabelTag() const { return "(300a,0043)"; }
115  bool setToleranceTableLabel(std::string parameter);
116 
117  // ToleranceTableNumber (300a,0042) vr=IS, vm=1, type=1
118  bool getToleranceTableNumber(std::string& parameter) const;
119  std::string getToleranceTableNumberTag() const { return "(300a,0042)"; }
120  bool setToleranceTableNumber(std::string parameter);
121 
122  // BeamLimitingDeviceToleranceSequence (300a,0048) vr=SQ, vm=1, type=3
124  std::string getBeamLimitingDeviceToleranceSequenceTag() const { return std::string("(300a,0048)"); }
126 
127 
128  private:
129 
130  DCMTree::TreePtr _dcmItem;
131 
132  };
133 
135 
137  DcmDRTIonToleranceTableSequenceInterface(std::vector<DcmDRTIonToleranceTableSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
138 
140  for(size_t i=0; i < treePtrSeq.size(); i++)
141  {
142  _itemVec.push_back(DcmDRTIonToleranceTableSequenceInterface::Item(treePtrSeq[i]));
143  }
144  }
145 
148  // BeamLimitingDeviceAngleTolerance (300a,0046) vr=DS, vm=1, type=3
149  bool getBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string& parameter) const;
150  bool getBeamLimitingDeviceAngleTolerance(DCMTree::TreePtr item, std::string& parameter) const;
151  std::string getBeamLimitingDeviceAngleToleranceTag() const { return "(300a,0046)"; }
152  bool setBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string parameter);
153 
154  // GantryAngleTolerance (300a,0044) vr=DS, vm=1, type=3
155  bool getGantryAngleTolerance(unsigned long idx, std::string& parameter) const;
156  bool getGantryAngleTolerance(DCMTree::TreePtr item, std::string& parameter) const;
157  std::string getGantryAngleToleranceTag() const { return "(300a,0044)"; }
158  bool setGantryAngleTolerance(unsigned long idx, std::string parameter);
159 
160  // PatientSupportAngleTolerance (300a,004c) vr=DS, vm=1, type=3
161  bool getPatientSupportAngleTolerance(unsigned long idx, std::string& parameter) const;
162  bool getPatientSupportAngleTolerance(DCMTree::TreePtr item, std::string& parameter) const;
163  std::string getPatientSupportAngleToleranceTag() const { return "(300a,004c)"; }
164  bool setPatientSupportAngleTolerance(unsigned long idx, std::string parameter);
165 
166  // SnoutPositionTolerance (300a,004b) vr=FL, vm=1, type=3
167  bool getSnoutPositionTolerance(unsigned long idx, float& parameter) const;
168  bool getSnoutPositionTolerance(DCMTree::TreePtr item, float& parameter) const;
169  std::string getSnoutPositionToleranceTag() const { return "(300a,004b)"; }
170  bool setSnoutPositionTolerance(unsigned long idx, float parameter);
171 
172  // TableTopLateralPositionTolerance (300a,0053) vr=DS, vm=1, type=3
173  bool getTableTopLateralPositionTolerance(unsigned long idx, std::string& parameter) const;
174  bool getTableTopLateralPositionTolerance(DCMTree::TreePtr item, std::string& parameter) const;
175  std::string getTableTopLateralPositionToleranceTag() const { return "(300a,0053)"; }
176  bool setTableTopLateralPositionTolerance(unsigned long idx, std::string parameter);
177 
178  // TableTopLongitudinalPositionTolerance (300a,0052) vr=DS, vm=1, type=3
179  bool getTableTopLongitudinalPositionTolerance(unsigned long idx, std::string& parameter) const;
180  bool getTableTopLongitudinalPositionTolerance(DCMTree::TreePtr item, std::string& parameter) const;
181  std::string getTableTopLongitudinalPositionToleranceTag() const { return "(300a,0052)"; }
182  bool setTableTopLongitudinalPositionTolerance(unsigned long idx, std::string parameter);
183 
184  // TableTopPitchAngleTolerance (300a,004f) vr=FL, vm=1, type=3
185  bool getTableTopPitchAngleTolerance(unsigned long idx, float& parameter) const;
186  bool getTableTopPitchAngleTolerance(DCMTree::TreePtr item, float& parameter) const;
187  std::string getTableTopPitchAngleToleranceTag() const { return "(300a,004f)"; }
188  bool setTableTopPitchAngleTolerance(unsigned long idx, float parameter);
189 
190  // TableTopRollAngleTolerance (300a,0050) vr=FL, vm=1, type=3
191  bool getTableTopRollAngleTolerance(unsigned long idx, float& parameter) const;
192  bool getTableTopRollAngleTolerance(DCMTree::TreePtr item, float& parameter) const;
193  std::string getTableTopRollAngleToleranceTag() const { return "(300a,0050)"; }
194  bool setTableTopRollAngleTolerance(unsigned long idx, float parameter);
195 
196  // TableTopVerticalPositionTolerance (300a,0051) vr=DS, vm=1, type=3
197  bool getTableTopVerticalPositionTolerance(unsigned long idx, std::string& parameter) const;
198  bool getTableTopVerticalPositionTolerance(DCMTree::TreePtr item, std::string& parameter) const;
199  std::string getTableTopVerticalPositionToleranceTag() const { return "(300a,0051)"; }
200  bool setTableTopVerticalPositionTolerance(unsigned long idx, std::string parameter);
201 
202  // ToleranceTableLabel (300a,0043) vr=SH, vm=1, type=3
203  bool getToleranceTableLabel(unsigned long idx, std::string& parameter) const;
204  bool getToleranceTableLabel(DCMTree::TreePtr item, std::string& parameter) const;
205  std::string getToleranceTableLabelTag() const { return "(300a,0043)"; }
206  bool setToleranceTableLabel(unsigned long idx, std::string parameter);
207 
208  // ToleranceTableNumber (300a,0042) vr=IS, vm=1, type=1
209  bool getToleranceTableNumber(unsigned long idx, std::string& parameter) const;
210  bool getToleranceTableNumber(DCMTree::TreePtr item, std::string& parameter) const;
211  std::string getToleranceTableNumberTag() const { return "(300a,0042)"; }
212  bool setToleranceTableNumber(unsigned long idx, std::string parameter);
213 
214  // BeamLimitingDeviceToleranceSequence (300a,0048) vr=SQ, vm=1, type=3
216  std::string getBeamLimitingDeviceToleranceSequenceTag() const { return std::string("(300a,0048)"); }
218 
219 
222  void setSequence(std::vector<DcmDRTIonToleranceTableSequenceInterface::Item> dcmSequence) {
223  _itemVec = dcmSequence;
224  }
225 
228  std::vector<DcmDRTIonToleranceTableSequenceInterface::Item> getSequence() const {
229  return _itemVec;
230  }
231 
234  bool hasSequence() const {
235  return (_itemVec.size() != 0);
236  }
237 
241  return static_cast<MLint>(_itemVec.size());
242  }
243 
247  if (_itemVec.size() > idx) {
248  return _itemVec[idx];
249  }
251  }
252 
257  return _itemVec[_itemVec.size()-1];
258  }
259 
261  _itemVec.push_back(newItem);
262  }
263 
266  bool insertItem(const size_t idx) {
267  if (_itemVec.size() > idx) {
268  std::vector<DcmDRTIonToleranceTableSequenceInterface::Item>::iterator it = _itemVec.begin();
269  std::advance(it, idx);
270  _itemVec.insert(it, DcmDRTIonToleranceTableSequenceInterface::Item());
271  return true;
272  }
273  return false;
274  }
275 
278  bool removeItem(const size_t idx) {
279  if ( _itemVec.size() > idx ) {
280  std::vector<DcmDRTIonToleranceTableSequenceInterface::Item>::iterator it = _itemVec.begin();
281  std::advance(it, idx);
282  _itemVec.erase(it);
283  return true;
284  }
285  return false;
286  }
287 
288  protected:
290  std::vector<DcmDRTIonToleranceTableSequenceInterface::Item> _itemVec;
291 };
292 
293 ML_END_NAMESPACE
294 
295 #endif // __mlDcmDRTIonToleranceTableSequenceInterface_H
296 
297 /* MeVis-Hidden-Components-Start */
298 /* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
Class to provide access to DRTBeamLimitingDeviceToleranceSequence.
bool getTableTopRollAngleTolerance(float &parameter) const
bool getSnoutPositionTolerance(float &parameter) const
bool getTableTopVerticalPositionTolerance(std::string &parameter) const
void setBeamLimitingDeviceToleranceSequence(DcmDRTBeamLimitingDeviceToleranceSequenceInterface seq)
bool setTableTopLongitudinalPositionTolerance(std::string parameter)
bool getTableTopLateralPositionTolerance(std::string &parameter) const
bool setTableTopLateralPositionTolerance(std::string parameter)
DcmDRTBeamLimitingDeviceToleranceSequenceInterface getBeamLimitingDeviceToleranceSequence() const
bool getTableTopPitchAngleTolerance(float &parameter) const
bool setToleranceTableNumber(std::string parameter)
bool setToleranceTableLabel(std::string parameter)
bool getToleranceTableLabel(std::string &parameter) const
bool getToleranceTableNumber(std::string &parameter) const
bool setPatientSupportAngleTolerance(std::string parameter)
bool setTableTopVerticalPositionTolerance(std::string parameter)
bool getGantryAngleTolerance(std::string &parameter) const
bool setBeamLimitingDeviceAngleTolerance(std::string parameter)
bool setGantryAngleTolerance(std::string parameter)
bool getTableTopLongitudinalPositionTolerance(std::string &parameter) const
bool getBeamLimitingDeviceAngleTolerance(std::string &parameter) const
bool getPatientSupportAngleTolerance(std::string &parameter) const
Class to provide access to DRTIonToleranceTableSequence.
void setSequence(std::vector< DcmDRTIonToleranceTableSequenceInterface::Item > dcmSequence)
Set the DRTIonToleranceTableSequence this interface class provides access to.
bool getPatientSupportAngleTolerance(unsigned long idx, std::string &parameter) const
bool getToleranceTableNumber(DCMTree::TreePtr item, std::string &parameter) const
bool getTableTopLateralPositionTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool setTableTopVerticalPositionTolerance(unsigned long idx, std::string parameter)
bool setBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string parameter)
std::vector< DcmDRTIonToleranceTableSequenceInterface::Item > getSequence() const
Return the DRTIonToleranceTableSequence this interface class provides access to.
DcmDRTBeamLimitingDeviceToleranceSequenceInterface getBeamLimitingDeviceToleranceSequence(unsigned long idx) const
bool getTableTopLongitudinalPositionTolerance(unsigned long idx, std::string &parameter) const
bool getPatientSupportAngleTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool getSnoutPositionTolerance(DCMTree::TreePtr item, float &parameter) const
bool getTableTopPitchAngleTolerance(DCMTree::TreePtr item, float &parameter) const
bool removeItem(const size_t idx)
Removes the indicated item from the sequence.
bool getGantryAngleTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool setTableTopRollAngleTolerance(unsigned long idx, float parameter)
bool getTableTopLateralPositionTolerance(unsigned long idx, std::string &parameter) const
DcmDRTIonToleranceTableSequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool getTableTopLongitudinalPositionTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool getTableTopPitchAngleTolerance(unsigned long idx, float &parameter) const
bool setPatientSupportAngleTolerance(unsigned long idx, std::string parameter)
bool setTableTopLateralPositionTolerance(unsigned long idx, std::string parameter)
bool getBeamLimitingDeviceAngleTolerance(unsigned long idx, std::string &parameter) const
bool getToleranceTableNumber(unsigned long idx, std::string &parameter) const
DcmDRTIonToleranceTableSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool getTableTopRollAngleTolerance(unsigned long idx, float &parameter) const
bool getTableTopVerticalPositionTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool setGantryAngleTolerance(unsigned long idx, std::string parameter)
DcmDRTIonToleranceTableSequenceInterface(std::vector< DcmDRTIonToleranceTableSequenceInterface::Item > dcmSequence)
Default Constructor.
bool getSnoutPositionTolerance(unsigned long idx, float &parameter) const
bool setTableTopLongitudinalPositionTolerance(unsigned long idx, std::string parameter)
void addItem(DcmDRTIonToleranceTableSequenceInterface::Item newItem)
bool getBeamLimitingDeviceAngleTolerance(DCMTree::TreePtr item, std::string &parameter) const
bool getToleranceTableLabel(DCMTree::TreePtr item, std::string &parameter) const
std::vector< DcmDRTIonToleranceTableSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
bool insertItem(const size_t idx)
Insert an item at the indicated position.
bool setToleranceTableLabel(unsigned long idx, std::string parameter)
void setBeamLimitingDeviceToleranceSequence(DcmDRTBeamLimitingDeviceToleranceSequenceInterface seq, unsigned long idx)
bool setTableTopPitchAngleTolerance(unsigned long idx, float parameter)
bool getTableTopVerticalPositionTolerance(unsigned long idx, std::string &parameter) const
bool setSnoutPositionTolerance(unsigned long idx, float parameter)
bool setToleranceTableNumber(unsigned long idx, std::string parameter)
bool getGantryAngleTolerance(unsigned long idx, std::string &parameter) const
bool getToleranceTableLabel(unsigned long idx, std::string &parameter) const
virtual ~DcmDRTIonToleranceTableSequenceInterface()
Default virtual Destructor.
bool hasSequence() const
Check if the DRTIonToleranceTableSequence is set.
bool getTableTopRollAngleTolerance(DCMTree::TreePtr item, float &parameter) const
Class to provide access to DRTBeamLimitingDeviceToleranceSequence.
Class collecting some DICOM helper functionality explicitly for dcmtk.
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition: mlTypeDefs.h:578
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:70