MeVisLab Toolbox Reference
mlDcmDRTShieldingDeviceSequenceInterface.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 __mlDcmDRTShieldingDeviceSequenceInterface_H
24#define __mlDcmDRTShieldingDeviceSequenceInterface_H
25
26// Local includes
27#include "mlDcmtkAccessories.h"
28
29// Dcmtk includes
30//#include "mlDcmDRTShieldingDeviceSequenceInterface.h" //DRTShieldingDeviceSequence
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 // AccessoryCode (300a,00f9) vr=LO, vm=1, type=3
67 bool getAccessoryCode(std::string& parameter) const;
68 std::string getAccessoryCodeTag() const { return "(300a,00f9)"; }
69 bool setAccessoryCode(std::string parameter);
70
71 // ShieldingDeviceDescription (300a,01a6) vr=ST, vm=1, type=3
72 bool getShieldingDeviceDescription(std::string& parameter) const;
73 std::string getShieldingDeviceDescriptionTag() const { return "(300a,01a6)"; }
74 bool setShieldingDeviceDescription(std::string parameter);
75
76 // ShieldingDeviceLabel (300a,01a4) vr=SH, vm=1, type=2C
77 bool getShieldingDeviceLabel(std::string& parameter) const;
78 std::string getShieldingDeviceLabelTag() const { return "(300a,01a4)"; }
79 bool setShieldingDeviceLabel(std::string parameter);
80
81 // ShieldingDevicePosition (300a,01a8) vr=SH, vm=1, type=3
82 bool getShieldingDevicePosition(std::string& parameter) const;
83 std::string getShieldingDevicePositionTag() const { return "(300a,01a8)"; }
84 bool setShieldingDevicePosition(std::string parameter);
85
86 // ShieldingDeviceType (300a,01a2) vr=CS, vm=1, type=1C
87 bool getShieldingDeviceType(std::string& parameter) const;
88 std::string getShieldingDeviceTypeTag() const { return "(300a,01a2)"; }
89 bool setShieldingDeviceType(std::string parameter);
90
91
92 private:
93
94 DCMTree::TreePtr _dcmItem;
95
96 };
97
99
101 DcmDRTShieldingDeviceSequenceInterface(std::vector<DcmDRTShieldingDeviceSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
102
109
112 // AccessoryCode (300a,00f9) vr=LO, vm=1, type=3
113 bool getAccessoryCode(unsigned long idx, std::string& parameter) const;
114 bool getAccessoryCode(DCMTree::TreePtr item, std::string& parameter) const;
115 std::string getAccessoryCodeTag() const { return "(300a,00f9)"; }
116 bool setAccessoryCode(unsigned long idx, std::string parameter);
117
118 // ShieldingDeviceDescription (300a,01a6) vr=ST, vm=1, type=3
119 bool getShieldingDeviceDescription(unsigned long idx, std::string& parameter) const;
120 bool getShieldingDeviceDescription(DCMTree::TreePtr item, std::string& parameter) const;
121 std::string getShieldingDeviceDescriptionTag() const { return "(300a,01a6)"; }
122 bool setShieldingDeviceDescription(unsigned long idx, std::string parameter);
123
124 // ShieldingDeviceLabel (300a,01a4) vr=SH, vm=1, type=2C
125 bool getShieldingDeviceLabel(unsigned long idx, std::string& parameter) const;
126 bool getShieldingDeviceLabel(DCMTree::TreePtr item, std::string& parameter) const;
127 std::string getShieldingDeviceLabelTag() const { return "(300a,01a4)"; }
128 bool setShieldingDeviceLabel(unsigned long idx, std::string parameter);
129
130 // ShieldingDevicePosition (300a,01a8) vr=SH, vm=1, type=3
131 bool getShieldingDevicePosition(unsigned long idx, std::string& parameter) const;
132 bool getShieldingDevicePosition(DCMTree::TreePtr item, std::string& parameter) const;
133 std::string getShieldingDevicePositionTag() const { return "(300a,01a8)"; }
134 bool setShieldingDevicePosition(unsigned long idx, std::string parameter);
135
136 // ShieldingDeviceType (300a,01a2) vr=CS, vm=1, type=1C
137 bool getShieldingDeviceType(unsigned long idx, std::string& parameter) const;
138 bool getShieldingDeviceType(DCMTree::TreePtr item, std::string& parameter) const;
139 std::string getShieldingDeviceTypeTag() const { return "(300a,01a2)"; }
140 bool setShieldingDeviceType(unsigned long idx, std::string parameter);
141
142
145 void setSequence(std::vector<DcmDRTShieldingDeviceSequenceInterface::Item> dcmSequence) {
146 _itemVec = dcmSequence;
147 }
148
151 std::vector<DcmDRTShieldingDeviceSequenceInterface::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
186
189 bool insertItem(const size_t idx) {
190 if (_itemVec.size() > idx) {
191 std::vector<DcmDRTShieldingDeviceSequenceInterface::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<DcmDRTShieldingDeviceSequenceInterface::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<DcmDRTShieldingDeviceSequenceInterface::Item> _itemVec;
214};
215
217
218#endif // __mlDcmDRTShieldingDeviceSequenceInterface_H
219
220/* MeVis-Hidden-Components-Start */
221/* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
bool getShieldingDeviceType(std::string &parameter) const
bool getShieldingDeviceLabel(std::string &parameter) const
bool getAccessoryCode(std::string &parameter) const
bool setShieldingDeviceDescription(std::string parameter)
bool getShieldingDevicePosition(std::string &parameter) const
bool setShieldingDeviceType(std::string parameter)
bool setShieldingDeviceLabel(std::string parameter)
bool setShieldingDevicePosition(std::string parameter)
bool setAccessoryCode(std::string parameter)
bool getShieldingDeviceDescription(std::string &parameter) const
Class to provide access to DRTShieldingDeviceSequence.
void addItem(DcmDRTShieldingDeviceSequenceInterface::Item newItem)
std::vector< DcmDRTShieldingDeviceSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
bool getShieldingDeviceDescription(unsigned long idx, std::string &parameter) const
bool setShieldingDevicePosition(unsigned long idx, std::string parameter)
bool getAccessoryCode(unsigned long idx, std::string &parameter) const
bool getShieldingDeviceDescription(DCMTree::TreePtr item, std::string &parameter) const
bool getShieldingDeviceLabel(unsigned long idx, std::string &parameter) const
bool removeItem(const size_t idx)
Removes the indicated item from the sequence.
bool getShieldingDeviceType(unsigned long idx, std::string &parameter) const
bool setShieldingDeviceDescription(unsigned long idx, std::string parameter)
std::vector< DcmDRTShieldingDeviceSequenceInterface::Item > getSequence() const
Return the DRTShieldingDeviceSequence this interface class provides access to.
bool insertItem(const size_t idx)
Insert an item at the indicated position.
bool setShieldingDeviceLabel(unsigned long idx, std::string parameter)
DcmDRTShieldingDeviceSequenceInterface(std::vector< DcmDRTShieldingDeviceSequenceInterface::Item > dcmSequence)
Default Constructor.
bool getShieldingDevicePosition(DCMTree::TreePtr item, std::string &parameter) const
bool getShieldingDeviceLabel(DCMTree::TreePtr item, std::string &parameter) const
bool setShieldingDeviceType(unsigned long idx, std::string parameter)
bool setAccessoryCode(unsigned long idx, std::string parameter)
bool getShieldingDevicePosition(unsigned long idx, std::string &parameter) const
void setSequence(std::vector< DcmDRTShieldingDeviceSequenceInterface::Item > dcmSequence)
Set the DRTShieldingDeviceSequence this interface class provides access to.
DcmDRTShieldingDeviceSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
DcmDRTShieldingDeviceSequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool hasSequence() const
Check if the DRTShieldingDeviceSequence is set.
virtual ~DcmDRTShieldingDeviceSequenceInterface()
Default virtual Destructor.
bool getShieldingDeviceType(DCMTree::TreePtr item, std::string &parameter) const
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
bool getAccessoryCode(DCMTree::TreePtr item, std::string &parameter) const
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