MeVisLab Toolbox Reference
mlDcmDRTRTReferencedSeriesSequenceInterface.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 __mlDcmDRTRTReferencedSeriesSequenceInterface_H
24 #define __mlDcmDRTRTReferencedSeriesSequenceInterface_H
25 
26 // Local includes
27 #include "mlDcmtkAccessories.h"
28 
29 // Dcmtk includes
30 //#include "mlDcmDRTRTReferencedSeriesSequenceInterface.h" //DRTRTReferencedSeriesSequence
31 #include "mlDcmDRTContourImageSequenceInterface.h" //DRTContourImageSequence
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  // SeriesInstanceUID (0020,000e) vr=UI, vm=1, type=1C
68  bool getSeriesInstanceUID(std::string& parameter) const;
69  std::string getSeriesInstanceUIDTag() const { return "(0020,000e)"; }
70  bool setSeriesInstanceUID(std::string parameter);
71 
72  // ContourImageSequence (3006,0016) vr=SQ, vm=1, type=1C
74  std::string getContourImageSequenceTag() const { return std::string("(3006,0016)"); }
76 
77 
78  private:
79 
80  DCMTree::TreePtr _dcmItem;
81 
82  };
83 
85 
87  DcmDRTRTReferencedSeriesSequenceInterface(std::vector<DcmDRTRTReferencedSeriesSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
88 
90  for(size_t i=0; i < treePtrSeq.size(); i++)
91  {
92  _itemVec.push_back(DcmDRTRTReferencedSeriesSequenceInterface::Item(treePtrSeq[i]));
93  }
94  }
95 
98  // SeriesInstanceUID (0020,000e) vr=UI, vm=1, type=1C
99  bool getSeriesInstanceUID(unsigned long idx, std::string& parameter) const;
100  bool getSeriesInstanceUID(DCMTree::TreePtr item, std::string& parameter) const;
101  std::string getSeriesInstanceUIDTag() const { return "(0020,000e)"; }
102  bool setSeriesInstanceUID(unsigned long idx, std::string parameter);
103 
104  // ContourImageSequence (3006,0016) vr=SQ, vm=1, type=1C
106  std::string getContourImageSequenceTag() const { return std::string("(3006,0016)"); }
108 
109 
112  void setSequence(std::vector<DcmDRTRTReferencedSeriesSequenceInterface::Item> dcmSequence) {
113  _itemVec = dcmSequence;
114  }
115 
118  std::vector<DcmDRTRTReferencedSeriesSequenceInterface::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 
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<DcmDRTRTReferencedSeriesSequenceInterface::Item>::iterator it = _itemVec.begin();
159  std::advance(it, idx);
161  return true;
162  }
163  return false;
164  }
165 
168  bool removeItem(const size_t idx) {
169  if ( _itemVec.size() > idx ) {
170  std::vector<DcmDRTRTReferencedSeriesSequenceInterface::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<DcmDRTRTReferencedSeriesSequenceInterface::Item> _itemVec;
181 };
182 
183 ML_END_NAMESPACE
184 
185 #endif // __mlDcmDRTRTReferencedSeriesSequenceInterface_H
186 
187 /* MeVis-Hidden-Components-Start */
188 /* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
Class to provide access to DRTContourImageSequence.
void setContourImageSequence(DcmDRTContourImageSequenceInterface seq)
DcmDRTContourImageSequenceInterface getContourImageSequence() const
bool getSeriesInstanceUID(std::string &parameter) const
Class to provide access to DRTRTReferencedSeriesSequence.
void setSequence(std::vector< DcmDRTRTReferencedSeriesSequenceInterface::Item > dcmSequence)
Set the DRTRTReferencedSeriesSequence this interface class provides access to.
std::vector< DcmDRTRTReferencedSeriesSequenceInterface::Item > getSequence() const
Return the DRTRTReferencedSeriesSequence this interface class provides access to.
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.
DcmDRTRTReferencedSeriesSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
void addItem(DcmDRTRTReferencedSeriesSequenceInterface::Item newItem)
bool setSeriesInstanceUID(unsigned long idx, std::string parameter)
bool getSeriesInstanceUID(unsigned long idx, std::string &parameter) const
bool hasSequence() const
Check if the DRTRTReferencedSeriesSequence is set.
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
DcmDRTContourImageSequenceInterface getContourImageSequence(unsigned long idx) const
bool getSeriesInstanceUID(DCMTree::TreePtr item, std::string &parameter) const
std::vector< DcmDRTRTReferencedSeriesSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
void setContourImageSequence(DcmDRTContourImageSequenceInterface seq, unsigned long idx)
DcmDRTRTReferencedSeriesSequenceInterface::Item & addItem()
Adds a new item to the sequence.
DcmDRTRTReferencedSeriesSequenceInterface(std::vector< DcmDRTRTReferencedSeriesSequenceInterface::Item > dcmSequence)
Default Constructor.
Class to provide access to DRTContourImageSequence.
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