MeVisLab Toolbox Reference
mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.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 __mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface_H
24 #define __mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface_H
25 
26 // Local includes
27 #include "mlDcmtkAccessories.h"
28 
29 // Dcmtk includes
30 //#include "mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface.h" //DRTBeamLimitingDeviceSequenceInRTImageModule
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  // LeafJawPositions (300a,011c) vr=DS, vm=2-2n, type=1C
67  bool getLeafJawPositions(std::string& parameter) const;
68  std::string getLeafJawPositionsTag() const { return "(300a,011c)"; }
69  bool setLeafJawPositions(std::string parameter);
70 
71  // LeafPositionBoundaries (300a,00be) vr=DS, vm=3-n, type=2C
72  bool getLeafPositionBoundaries(std::string& parameter) const;
73  std::string getLeafPositionBoundariesTag() const { return "(300a,00be)"; }
74  bool setLeafPositionBoundaries(std::string parameter);
75 
76  // NumberOfLeafJawPairs (300a,00bc) vr=IS, vm=1, type=1C
77  bool getNumberOfLeafJawPairs(std::string& parameter) const;
78  std::string getNumberOfLeafJawPairsTag() const { return "(300a,00bc)"; }
79  bool setNumberOfLeafJawPairs(std::string parameter);
80 
81  // RTBeamLimitingDeviceType (300a,00b8) vr=CS, vm=1, type=1C
82  bool getRTBeamLimitingDeviceType(std::string& parameter) const;
83  std::string getRTBeamLimitingDeviceTypeTag() const { return "(300a,00b8)"; }
84  bool setRTBeamLimitingDeviceType(std::string parameter);
85 
86  // SourceToBeamLimitingDeviceDistance (300a,00ba) vr=DS, vm=1, type=3
87  bool getSourceToBeamLimitingDeviceDistance(std::string& parameter) const;
88  std::string getSourceToBeamLimitingDeviceDistanceTag() const { return "(300a,00ba)"; }
89  bool setSourceToBeamLimitingDeviceDistance(std::string parameter);
90 
91 
92  private:
93 
94  DCMTree::TreePtr _dcmItem;
95 
96  };
97 
99 
101  DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface(std::vector<DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
102 
104  for(size_t i=0; i < treePtrSeq.size(); i++)
105  {
106  _itemVec.push_back(DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item(treePtrSeq[i]));
107  }
108  }
109 
112  // LeafJawPositions (300a,011c) vr=DS, vm=2-2n, type=1C
113  bool getLeafJawPositions(unsigned long idx, std::string& parameter) const;
114  bool getLeafJawPositions(DCMTree::TreePtr item, std::string& parameter) const;
115  std::string getLeafJawPositionsTag() const { return "(300a,011c)"; }
116  bool setLeafJawPositions(unsigned long idx, std::string parameter);
117 
118  // LeafPositionBoundaries (300a,00be) vr=DS, vm=3-n, type=2C
119  bool getLeafPositionBoundaries(unsigned long idx, std::string& parameter) const;
120  bool getLeafPositionBoundaries(DCMTree::TreePtr item, std::string& parameter) const;
121  std::string getLeafPositionBoundariesTag() const { return "(300a,00be)"; }
122  bool setLeafPositionBoundaries(unsigned long idx, std::string parameter);
123 
124  // NumberOfLeafJawPairs (300a,00bc) vr=IS, vm=1, type=1C
125  bool getNumberOfLeafJawPairs(unsigned long idx, std::string& parameter) const;
126  bool getNumberOfLeafJawPairs(DCMTree::TreePtr item, std::string& parameter) const;
127  std::string getNumberOfLeafJawPairsTag() const { return "(300a,00bc)"; }
128  bool setNumberOfLeafJawPairs(unsigned long idx, std::string parameter);
129 
130  // RTBeamLimitingDeviceType (300a,00b8) vr=CS, vm=1, type=1C
131  bool getRTBeamLimitingDeviceType(unsigned long idx, std::string& parameter) const;
132  bool getRTBeamLimitingDeviceType(DCMTree::TreePtr item, std::string& parameter) const;
133  std::string getRTBeamLimitingDeviceTypeTag() const { return "(300a,00b8)"; }
134  bool setRTBeamLimitingDeviceType(unsigned long idx, std::string parameter);
135 
136  // SourceToBeamLimitingDeviceDistance (300a,00ba) vr=DS, vm=1, type=3
137  bool getSourceToBeamLimitingDeviceDistance(unsigned long idx, std::string& parameter) const;
138  bool getSourceToBeamLimitingDeviceDistance(DCMTree::TreePtr item, std::string& parameter) const;
139  std::string getSourceToBeamLimitingDeviceDistanceTag() const { return "(300a,00ba)"; }
140  bool setSourceToBeamLimitingDeviceDistance(unsigned long idx, std::string parameter);
141 
142 
145  void setSequence(std::vector<DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item> dcmSequence) {
146  _itemVec = dcmSequence;
147  }
148 
151  std::vector<DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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 
180  return _itemVec[_itemVec.size()-1];
181  }
182 
184  _itemVec.push_back(newItem);
185  }
186 
189  bool insertItem(const size_t idx) {
190  if (_itemVec.size() > idx) {
191  std::vector<DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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<DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::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<DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item> _itemVec;
214 };
215 
216 ML_END_NAMESPACE
217 
218 #endif // __mlDcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface_H
219 
220 /* MeVis-Hidden-Components-Start */
221 /* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
bool getSourceToBeamLimitingDeviceDistance(std::string &parameter) const
Class to provide access to DRTBeamLimitingDeviceSequenceInRTImageModule.
bool getLeafPositionBoundaries(DCMTree::TreePtr item, std::string &parameter) const
bool getNumberOfLeafJawPairs(DCMTree::TreePtr item, std::string &parameter) const
DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface(std::vector< DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item > dcmSequence)
Default Constructor.
bool getLeafJawPositions(DCMTree::TreePtr item, std::string &parameter) const
bool getLeafJawPositions(unsigned long idx, std::string &parameter) const
bool setLeafPositionBoundaries(unsigned long idx, std::string parameter)
void addItem(DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item newItem)
bool getRTBeamLimitingDeviceType(unsigned long idx, std::string &parameter) const
bool setLeafJawPositions(unsigned long idx, std::string parameter)
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
bool getSourceToBeamLimitingDeviceDistance(unsigned long idx, std::string &parameter) const
bool getSourceToBeamLimitingDeviceDistance(DCMTree::TreePtr item, std::string &parameter) const
void setSequence(std::vector< DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item > dcmSequence)
Set the DRTBeamLimitingDeviceSequenceInRTImageModule this interface class provides access to.
bool hasSequence() const
Check if the DRTBeamLimitingDeviceSequenceInRTImageModule is set.
DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool getLeafPositionBoundaries(unsigned long idx, std::string &parameter) const
std::vector< DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
bool getNumberOfLeafJawPairs(unsigned long idx, std::string &parameter) const
bool setRTBeamLimitingDeviceType(unsigned long idx, std::string parameter)
bool setNumberOfLeafJawPairs(unsigned long idx, std::string parameter)
bool getRTBeamLimitingDeviceType(DCMTree::TreePtr item, std::string &parameter) const
bool setSourceToBeamLimitingDeviceDistance(unsigned long idx, std::string parameter)
DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item & addItem()
Adds a new item to the sequence.
std::vector< DcmDRTBeamLimitingDeviceSequenceInRTImageModuleInterface::Item > getSequence() const
Return the DRTBeamLimitingDeviceSequenceInRTImageModule this interface class provides access to.
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