MeVisLab Toolbox Reference
mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.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 __mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface_H
24 #define __mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface_H
25 
26 // Local includes
27 #include "mlDcmtkAccessories.h"
28 
29 // Dcmtk includes
30 //#include "mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface.h" //DRTRangeShifterSettingsSequenceInRTIonBeamsModule
31 
32 
33 // ML includes
34 #ifndef __mlModuleIncludes_H
35 #include "mlModuleIncludes.h"
36 #endif
37 
38 ML_START_NAMESPACE
39 
40 // ------------------------------------------------------------------
42 // ------------------------------------------------------------------
44 {
45  public:
46 
48  {
49  public:
50 
51  Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
52 
53  Item(DCMTree::TreePtr dcmItem) : _dcmItem(dcmItem) {}
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  // IsocenterToRangeShifterDistance (300a,0364) vr=FL, vm=1, type=3
67  bool getIsocenterToRangeShifterDistance(float& parameter) const;
68  std::string getIsocenterToRangeShifterDistanceTag() const { return "(300a,0364)"; }
69  bool setIsocenterToRangeShifterDistance(float parameter);
70 
71  // RangeShifterSetting (300a,0362) vr=LO, vm=1, type=1
72  bool getRangeShifterSetting(std::string& parameter) const;
73  std::string getRangeShifterSettingTag() const { return "(300a,0362)"; }
74  bool setRangeShifterSetting(std::string parameter);
75 
76  // RangeShifterWaterEquivalentThickness (300a,0366) vr=FL, vm=1, type=3
77  bool getRangeShifterWaterEquivalentThickness(float& parameter) const;
78  std::string getRangeShifterWaterEquivalentThicknessTag() const { return "(300a,0366)"; }
80 
81  // ReferencedRangeShifterNumber (300c,0100) vr=IS, vm=1, type=1
82  bool getReferencedRangeShifterNumber(std::string& parameter) const;
83  std::string getReferencedRangeShifterNumberTag() const { return "(300c,0100)"; }
84  bool setReferencedRangeShifterNumber(std::string parameter);
85 
86 
87  private:
88 
89  DCMTree::TreePtr _dcmItem;
90 
91  };
92 
94 
96  DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface(std::vector<DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
97 
99  for(size_t i=0; i < treePtrSeq.size(); i++)
100  {
102  }
103  }
104 
107  // IsocenterToRangeShifterDistance (300a,0364) vr=FL, vm=1, type=3
108  bool getIsocenterToRangeShifterDistance(unsigned long idx, float& parameter) const;
109  bool getIsocenterToRangeShifterDistance(DCMTree::TreePtr item, float& parameter) const;
110  std::string getIsocenterToRangeShifterDistanceTag() const { return "(300a,0364)"; }
111  bool setIsocenterToRangeShifterDistance(unsigned long idx, float parameter);
112 
113  // RangeShifterSetting (300a,0362) vr=LO, vm=1, type=1
114  bool getRangeShifterSetting(unsigned long idx, std::string& parameter) const;
115  bool getRangeShifterSetting(DCMTree::TreePtr item, std::string& parameter) const;
116  std::string getRangeShifterSettingTag() const { return "(300a,0362)"; }
117  bool setRangeShifterSetting(unsigned long idx, std::string parameter);
118 
119  // RangeShifterWaterEquivalentThickness (300a,0366) vr=FL, vm=1, type=3
120  bool getRangeShifterWaterEquivalentThickness(unsigned long idx, float& parameter) const;
121  bool getRangeShifterWaterEquivalentThickness(DCMTree::TreePtr item, float& parameter) const;
122  std::string getRangeShifterWaterEquivalentThicknessTag() const { return "(300a,0366)"; }
123  bool setRangeShifterWaterEquivalentThickness(unsigned long idx, float parameter);
124 
125  // ReferencedRangeShifterNumber (300c,0100) vr=IS, vm=1, type=1
126  bool getReferencedRangeShifterNumber(unsigned long idx, std::string& parameter) const;
127  bool getReferencedRangeShifterNumber(DCMTree::TreePtr item, std::string& parameter) const;
128  std::string getReferencedRangeShifterNumberTag() const { return "(300c,0100)"; }
129  bool setReferencedRangeShifterNumber(unsigned long idx, std::string parameter);
130 
131 
134  void setSequence(std::vector<DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item> dcmSequence) {
135  _itemVec = dcmSequence;
136  }
137 
140  std::vector<DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item> getSequence() const {
141  return _itemVec;
142  }
143 
146  bool hasSequence() const {
147  return (_itemVec.size() != 0);
148  }
149 
153  return static_cast<MLint>(_itemVec.size());
154  }
155 
159  if (_itemVec.size() > idx) {
160  return _itemVec[idx];
161  }
163  }
164 
169  return _itemVec[_itemVec.size()-1];
170  }
171 
173  _itemVec.push_back(newItem);
174  }
175 
178  bool insertItem(const size_t idx) {
179  if (_itemVec.size() > idx) {
180  std::vector<DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item>::iterator it = _itemVec.begin();
181  std::advance(it, idx);
183  return true;
184  }
185  return false;
186  }
187 
190  bool removeItem(const size_t idx) {
191  if ( _itemVec.size() > idx ) {
192  std::vector<DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item>::iterator it = _itemVec.begin();
193  std::advance(it, idx);
194  _itemVec.erase(it);
195  return true;
196  }
197  return false;
198  }
199 
200  protected:
202  std::vector<DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item> _itemVec;
203 };
204 
205 ML_END_NAMESPACE
206 
207 #endif // __mlDcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface_H
208 
209 /* MeVis-Hidden-Components-Start */
210 /* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
Class to provide access to DRTRangeShifterSettingsSequenceInRTIonBeamsModule.
bool setRangeShifterWaterEquivalentThickness(unsigned long idx, float parameter)
bool getIsocenterToRangeShifterDistance(unsigned long idx, float &parameter) const
bool setIsocenterToRangeShifterDistance(unsigned long idx, float parameter)
void setSequence(std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
Set the DRTRangeShifterSettingsSequenceInRTIonBeamsModule this interface class provides access to.
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool getRangeShifterSetting(unsigned long idx, std::string &parameter) const
bool getRangeShifterWaterEquivalentThickness(DCMTree::TreePtr item, float &parameter) const
void addItem(DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item newItem)
bool setRangeShifterSetting(unsigned long idx, std::string parameter)
bool hasSequence() const
Check if the DRTRangeShifterSettingsSequenceInRTIonBeamsModule is set.
bool getReferencedRangeShifterNumber(unsigned long idx, std::string &parameter) const
bool getIsocenterToRangeShifterDistance(DCMTree::TreePtr item, float &parameter) const
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item & addItem()
Adds a new item to the sequence.
std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item > getSequence() const
Return the DRTRangeShifterSettingsSequenceInRTIonBeamsModule this interface class provides access to.
bool getRangeShifterWaterEquivalentThickness(unsigned long idx, float &parameter) const
bool getReferencedRangeShifterNumber(DCMTree::TreePtr item, std::string &parameter) const
std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
bool setReferencedRangeShifterNumber(unsigned long idx, std::string parameter)
DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface(std::vector< DcmDRTRangeShifterSettingsSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
Default Constructor.
bool getRangeShifterSetting(DCMTree::TreePtr item, std::string &parameter) const
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