MeVisLab Toolbox Reference
mlDcmDRTFluenceMapSequenceInterface.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 __mlDcmDRTFluenceMapSequenceInterface_H
24 #define __mlDcmDRTFluenceMapSequenceInterface_H
25 
26 // Local includes
27 #include "mlDcmtkAccessories.h"
28 
29 // Dcmtk includes
30 //#include "mlDcmDRTFluenceMapSequenceInterface.h" //DRTFluenceMapSequence
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  // FluenceDataScale (3002,0042) vr=DS, vm=1, type=3
67  bool getFluenceDataScale(std::string& parameter) const;
68  std::string getFluenceDataScaleTag() const { return "(3002,0042)"; }
69  bool setFluenceDataScale(std::string parameter);
70 
71  // FluenceDataSource (3002,0041) vr=CS, vm=1, type=1
72  bool getFluenceDataSource(std::string& parameter) const;
73  std::string getFluenceDataSourceTag() const { return "(3002,0041)"; }
74  bool setFluenceDataSource(std::string parameter);
75 
76 
77  private:
78 
79  DCMTree::TreePtr _dcmItem;
80 
81  };
82 
84 
86  DcmDRTFluenceMapSequenceInterface(std::vector<DcmDRTFluenceMapSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
87 
89  for(size_t i=0; i < treePtrSeq.size(); i++)
90  {
91  _itemVec.push_back(DcmDRTFluenceMapSequenceInterface::Item(treePtrSeq[i]));
92  }
93  }
94 
97  // FluenceDataScale (3002,0042) vr=DS, vm=1, type=3
98  bool getFluenceDataScale(unsigned long idx, std::string& parameter) const;
99  bool getFluenceDataScale(DCMTree::TreePtr item, std::string& parameter) const;
100  std::string getFluenceDataScaleTag() const { return "(3002,0042)"; }
101  bool setFluenceDataScale(unsigned long idx, std::string parameter);
102 
103  // FluenceDataSource (3002,0041) vr=CS, vm=1, type=1
104  bool getFluenceDataSource(unsigned long idx, std::string& parameter) const;
105  bool getFluenceDataSource(DCMTree::TreePtr item, std::string& parameter) const;
106  std::string getFluenceDataSourceTag() const { return "(3002,0041)"; }
107  bool setFluenceDataSource(unsigned long idx, std::string parameter);
108 
109 
112  void setSequence(std::vector<DcmDRTFluenceMapSequenceInterface::Item> dcmSequence) {
113  _itemVec = dcmSequence;
114  }
115 
118  std::vector<DcmDRTFluenceMapSequenceInterface::Item> getSequence() const {
119  return _itemVec;
120  }
121 
124  bool hasSequence() const {
125  return (_itemVec.size() != 0);
126  }
127 
131  return static_cast<MLint>(_itemVec.size());
132  }
133 
137  if (_itemVec.size() > idx) {
138  return _itemVec[idx];
139  }
141  }
142 
146  _itemVec.push_back(DcmDRTFluenceMapSequenceInterface::Item());
147  return _itemVec[_itemVec.size()-1];
148  }
149 
151  _itemVec.push_back(newItem);
152  }
153 
156  bool insertItem(const size_t idx) {
157  if (_itemVec.size() > idx) {
158  std::vector<DcmDRTFluenceMapSequenceInterface::Item>::iterator it = _itemVec.begin();
159  std::advance(it, idx);
160  _itemVec.insert(it, DcmDRTFluenceMapSequenceInterface::Item());
161  return true;
162  }
163  return false;
164  }
165 
168  bool removeItem(const size_t idx) {
169  if ( _itemVec.size() > idx ) {
170  std::vector<DcmDRTFluenceMapSequenceInterface::Item>::iterator it = _itemVec.begin();
171  std::advance(it, idx);
172  _itemVec.erase(it);
173  return true;
174  }
175  return false;
176  }
177 
178  protected:
180  std::vector<DcmDRTFluenceMapSequenceInterface::Item> _itemVec;
181 };
182 
183 ML_END_NAMESPACE
184 
185 #endif // __mlDcmDRTFluenceMapSequenceInterface_H
186 
187 /* MeVis-Hidden-Components-Start */
188 /* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
bool setFluenceDataScale(std::string parameter)
bool getFluenceDataScale(std::string &parameter) const
bool getFluenceDataSource(std::string &parameter) const
bool setFluenceDataSource(std::string parameter)
Class to provide access to DRTFluenceMapSequence.
std::vector< DcmDRTFluenceMapSequenceInterface::Item > getSequence() const
Return the DRTFluenceMapSequence this interface class provides access to.
DcmDRTFluenceMapSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
DcmDRTFluenceMapSequenceInterface(DCMTree::TreePtrVector treePtrSeq)
bool getFluenceDataSource(unsigned long idx, std::string &parameter) const
bool setFluenceDataSource(unsigned long idx, std::string parameter)
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
virtual ~DcmDRTFluenceMapSequenceInterface()
Default virtual Destructor.
bool getFluenceDataSource(DCMTree::TreePtr item, std::string &parameter) const
void setSequence(std::vector< DcmDRTFluenceMapSequenceInterface::Item > dcmSequence)
Set the DRTFluenceMapSequence this interface class provides access to.
bool getFluenceDataScale(unsigned long idx, std::string &parameter) const
DcmDRTFluenceMapSequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool insertItem(const size_t idx)
Insert an item at the indicated position.
bool removeItem(const size_t idx)
Removes the indicated item from the sequence.
bool hasSequence() const
Check if the DRTFluenceMapSequence is set.
std::vector< DcmDRTFluenceMapSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
DcmDRTFluenceMapSequenceInterface(std::vector< DcmDRTFluenceMapSequenceInterface::Item > dcmSequence)
Default Constructor.
bool setFluenceDataScale(unsigned long idx, std::string parameter)
bool getFluenceDataScale(DCMTree::TreePtr item, std::string &parameter) const
void addItem(DcmDRTFluenceMapSequenceInterface::Item newItem)
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