MeVisLab Toolbox Reference
mlDcmDRTRTDoseROISequenceInterface.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 __mlDcmDRTRTDoseROISequenceInterface_H
24#define __mlDcmDRTRTDoseROISequenceInterface_H
25
26// Local includes
27#include "mlDcmtkAccessories.h"
28
29// Dcmtk includes
30//#include "mlDcmDRTRTDoseROISequenceInterface.h" //DRTRTDoseROISequence
31
32
33// ML includes
34#ifndef __mlModuleIncludes_H
35#include "mlModuleIncludes.h"
36#endif
37
39
40// ------------------------------------------------------------------
42// ------------------------------------------------------------------
44{
45 public:
46
48 {
49 public:
50
51 Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
52
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 // DoseUnits (3004,0002) vr=CS, vm=1, type=1
67 bool getDoseUnits(std::string& parameter) const;
68 std::string getDoseUnitsTag() const { return "(3004,0002)"; }
69 bool setDoseUnits(std::string parameter);
70
71 // DoseValue (3004,0012) vr=DS, vm=1, type=1
72 bool getDoseValue(std::string& parameter) const;
73 std::string getDoseValueTag() const { return "(3004,0012)"; }
74 bool setDoseValue(std::string parameter);
75
76 // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1
77 bool getReferencedROINumber(std::string& parameter) const;
78 std::string getReferencedROINumberTag() const { return "(3006,0084)"; }
79 bool setReferencedROINumber(std::string parameter);
80
81
82 private:
83
84 DCMTree::TreePtr _dcmItem;
85
86 };
87
89
91 DcmDRTRTDoseROISequenceInterface(std::vector<DcmDRTRTDoseROISequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
92
99
102 // DoseUnits (3004,0002) vr=CS, vm=1, type=1
103 bool getDoseUnits(unsigned long idx, std::string& parameter) const;
104 bool getDoseUnits(DCMTree::TreePtr item, std::string& parameter) const;
105 std::string getDoseUnitsTag() const { return "(3004,0002)"; }
106 bool setDoseUnits(unsigned long idx, std::string parameter);
107
108 // DoseValue (3004,0012) vr=DS, vm=1, type=1
109 bool getDoseValue(unsigned long idx, std::string& parameter) const;
110 bool getDoseValue(DCMTree::TreePtr item, std::string& parameter) const;
111 std::string getDoseValueTag() const { return "(3004,0012)"; }
112 bool setDoseValue(unsigned long idx, std::string parameter);
113
114 // ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1
115 bool getReferencedROINumber(unsigned long idx, std::string& parameter) const;
116 bool getReferencedROINumber(DCMTree::TreePtr item, std::string& parameter) const;
117 std::string getReferencedROINumberTag() const { return "(3006,0084)"; }
118 bool setReferencedROINumber(unsigned long idx, std::string parameter);
119
120
123 void setSequence(std::vector<DcmDRTRTDoseROISequenceInterface::Item> dcmSequence) {
124 _itemVec = dcmSequence;
125 }
126
129 std::vector<DcmDRTRTDoseROISequenceInterface::Item> getSequence() const {
130 return _itemVec;
131 }
132
135 bool hasSequence() const {
136 return (_itemVec.size() != 0);
137 }
138
142 return static_cast<MLint>(_itemVec.size());
143 }
144
148 if (_itemVec.size() > idx) {
149 return _itemVec[idx];
150 }
152 }
153
157 _itemVec.push_back(DcmDRTRTDoseROISequenceInterface::Item());
158 return _itemVec[_itemVec.size()-1];
159 }
160
162 _itemVec.push_back(newItem);
163 }
164
167 bool insertItem(const size_t idx) {
168 if (_itemVec.size() > idx) {
169 std::vector<DcmDRTRTDoseROISequenceInterface::Item>::iterator it = _itemVec.begin();
170 std::advance(it, idx);
171 _itemVec.insert(it, DcmDRTRTDoseROISequenceInterface::Item());
172 return true;
173 }
174 return false;
175 }
176
179 bool removeItem(const size_t idx) {
180 if ( _itemVec.size() > idx ) {
181 std::vector<DcmDRTRTDoseROISequenceInterface::Item>::iterator it = _itemVec.begin();
182 std::advance(it, idx);
183 _itemVec.erase(it);
184 return true;
185 }
186 return false;
187 }
188
189 protected:
191 std::vector<DcmDRTRTDoseROISequenceInterface::Item> _itemVec;
192};
193
195
196#endif // __mlDcmDRTRTDoseROISequenceInterface_H
197
198/* MeVis-Hidden-Components-Start */
199/* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
bool getDoseValue(std::string &parameter) const
bool setReferencedROINumber(std::string parameter)
bool getReferencedROINumber(std::string &parameter) const
bool getDoseUnits(std::string &parameter) const
bool setDoseValue(std::string parameter)
bool setDoseUnits(std::string parameter)
Class to provide access to DRTRTDoseROISequence.
bool getReferencedROINumber(unsigned long idx, std::string &parameter) const
void setSequence(std::vector< DcmDRTRTDoseROISequenceInterface::Item > dcmSequence)
Set the DRTRTDoseROISequence this interface class provides access to.
virtual ~DcmDRTRTDoseROISequenceInterface()
Default virtual Destructor.
std::vector< DcmDRTRTDoseROISequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
bool setDoseUnits(unsigned long idx, std::string parameter)
bool setReferencedROINumber(unsigned long idx, std::string parameter)
DcmDRTRTDoseROISequenceInterface(std::vector< DcmDRTRTDoseROISequenceInterface::Item > dcmSequence)
Default Constructor.
DcmDRTRTDoseROISequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool setDoseValue(unsigned long idx, std::string parameter)
bool getDoseUnits(DCMTree::TreePtr item, std::string &parameter) const
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
bool removeItem(const size_t idx)
Removes the indicated item from the sequence.
bool insertItem(const size_t idx)
Insert an item at the indicated position.
bool hasSequence() const
Check if the DRTRTDoseROISequence is set.
bool getDoseValue(unsigned long idx, std::string &parameter) const
std::vector< DcmDRTRTDoseROISequenceInterface::Item > getSequence() const
Return the DRTRTDoseROISequence this interface class provides access to.
DcmDRTRTDoseROISequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool getReferencedROINumber(DCMTree::TreePtr item, std::string &parameter) const
DcmDRTRTDoseROISequenceInterface(DCMTree::TreePtrVector treePtrSeq)
bool getDoseValue(DCMTree::TreePtr item, std::string &parameter) const
bool getDoseUnits(unsigned long idx, std::string &parameter) const
void addItem(DcmDRTRTDoseROISequenceInterface::Item newItem)
Class collecting some DICOM helper functionality explicitly for dcmtk.
Target mlrange_cast(Source arg)
Generic version of checked ML casts.
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition mlTypeDefs.h:490
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:72