MeVisLab Toolbox Reference
mlDcmDRTRangeShifterSequenceInterface.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 __mlDcmDRTRangeShifterSequenceInterface_H
24#define __mlDcmDRTRangeShifterSequenceInterface_H
25
26// Local includes
27#include "mlDcmtkAccessories.h"
28
29// Dcmtk includes
30//#include "mlDcmDRTRangeShifterSequenceInterface.h" //DRTRangeShifterSequence
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 // RangeShifterDescription (300a,0322) vr=LO, vm=1, type=3
72 bool getRangeShifterDescription(std::string& parameter) const;
73 std::string getRangeShifterDescriptionTag() const { return "(300a,0322)"; }
74 bool setRangeShifterDescription(std::string parameter);
75
76 // RangeShifterID (300a,0318) vr=SH, vm=1, type=1
77 bool getRangeShifterID(std::string& parameter) const;
78 std::string getRangeShifterIDTag() const { return "(300a,0318)"; }
79 bool setRangeShifterID(std::string parameter);
80
81 // RangeShifterNumber (300a,0316) vr=IS, vm=1, type=1
82 bool getRangeShifterNumber(std::string& parameter) const;
83 std::string getRangeShifterNumberTag() const { return "(300a,0316)"; }
84 bool setRangeShifterNumber(std::string parameter);
85
86 // RangeShifterType (300a,0320) vr=CS, vm=1, type=1
87 bool getRangeShifterType(std::string& parameter) const;
88 std::string getRangeShifterTypeTag() const { return "(300a,0320)"; }
89 bool setRangeShifterType(std::string parameter);
90
91
92 private:
93
94 DCMTree::TreePtr _dcmItem;
95
96 };
97
99
101 DcmDRTRangeShifterSequenceInterface(std::vector<DcmDRTRangeShifterSequenceInterface::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 // RangeShifterDescription (300a,0322) vr=LO, vm=1, type=3
119 bool getRangeShifterDescription(unsigned long idx, std::string& parameter) const;
120 bool getRangeShifterDescription(DCMTree::TreePtr item, std::string& parameter) const;
121 std::string getRangeShifterDescriptionTag() const { return "(300a,0322)"; }
122 bool setRangeShifterDescription(unsigned long idx, std::string parameter);
123
124 // RangeShifterID (300a,0318) vr=SH, vm=1, type=1
125 bool getRangeShifterID(unsigned long idx, std::string& parameter) const;
126 bool getRangeShifterID(DCMTree::TreePtr item, std::string& parameter) const;
127 std::string getRangeShifterIDTag() const { return "(300a,0318)"; }
128 bool setRangeShifterID(unsigned long idx, std::string parameter);
129
130 // RangeShifterNumber (300a,0316) vr=IS, vm=1, type=1
131 bool getRangeShifterNumber(unsigned long idx, std::string& parameter) const;
132 bool getRangeShifterNumber(DCMTree::TreePtr item, std::string& parameter) const;
133 std::string getRangeShifterNumberTag() const { return "(300a,0316)"; }
134 bool setRangeShifterNumber(unsigned long idx, std::string parameter);
135
136 // RangeShifterType (300a,0320) vr=CS, vm=1, type=1
137 bool getRangeShifterType(unsigned long idx, std::string& parameter) const;
138 bool getRangeShifterType(DCMTree::TreePtr item, std::string& parameter) const;
139 std::string getRangeShifterTypeTag() const { return "(300a,0320)"; }
140 bool setRangeShifterType(unsigned long idx, std::string parameter);
141
142
145 void setSequence(std::vector<DcmDRTRangeShifterSequenceInterface::Item> dcmSequence) {
146 _itemVec = dcmSequence;
147 }
148
151 std::vector<DcmDRTRangeShifterSequenceInterface::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
179 _itemVec.push_back(DcmDRTRangeShifterSequenceInterface::Item());
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<DcmDRTRangeShifterSequenceInterface::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<DcmDRTRangeShifterSequenceInterface::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<DcmDRTRangeShifterSequenceInterface::Item> _itemVec;
214};
215
217
218#endif // __mlDcmDRTRangeShifterSequenceInterface_H
219
220/* MeVis-Hidden-Components-Start */
221/* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
bool setRangeShifterNumber(std::string parameter)
bool getRangeShifterID(std::string &parameter) const
bool getRangeShifterType(std::string &parameter) const
bool setRangeShifterType(std::string parameter)
bool getAccessoryCode(std::string &parameter) const
bool getRangeShifterDescription(std::string &parameter) const
bool setRangeShifterID(std::string parameter)
bool getRangeShifterNumber(std::string &parameter) const
bool setRangeShifterDescription(std::string parameter)
bool setAccessoryCode(std::string parameter)
Class to provide access to DRTRangeShifterSequence.
bool getRangeShifterType(DCMTree::TreePtr item, std::string &parameter) const
bool getRangeShifterDescription(DCMTree::TreePtr item, std::string &parameter) const
DcmDRTRangeShifterSequenceInterface(std::vector< DcmDRTRangeShifterSequenceInterface::Item > dcmSequence)
Default Constructor.
bool insertItem(const size_t idx)
Insert an item at the indicated position.
bool getRangeShifterNumber(DCMTree::TreePtr item, std::string &parameter) const
virtual ~DcmDRTRangeShifterSequenceInterface()
Default virtual Destructor.
bool hasSequence() const
Check if the DRTRangeShifterSequence is set.
bool setRangeShifterType(unsigned long idx, std::string parameter)
void addItem(DcmDRTRangeShifterSequenceInterface::Item newItem)
bool removeItem(const size_t idx)
Removes the indicated item from the sequence.
bool getRangeShifterID(unsigned long idx, std::string &parameter) const
void setSequence(std::vector< DcmDRTRangeShifterSequenceInterface::Item > dcmSequence)
Set the DRTRangeShifterSequence this interface class provides access to.
bool setAccessoryCode(unsigned long idx, std::string parameter)
bool setRangeShifterID(unsigned long idx, std::string parameter)
DcmDRTRangeShifterSequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool setRangeShifterNumber(unsigned long idx, std::string parameter)
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
bool getRangeShifterType(unsigned long idx, std::string &parameter) const
DcmDRTRangeShifterSequenceInterface(DCMTree::TreePtrVector treePtrSeq)
bool getAccessoryCode(DCMTree::TreePtr item, std::string &parameter) const
bool getRangeShifterNumber(unsigned long idx, std::string &parameter) const
std::vector< DcmDRTRangeShifterSequenceInterface::Item > getSequence() const
Return the DRTRangeShifterSequence this interface class provides access to.
bool getRangeShifterDescription(unsigned long idx, std::string &parameter) const
bool getAccessoryCode(unsigned long idx, std::string &parameter) const
std::vector< DcmDRTRangeShifterSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
DcmDRTRangeShifterSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool setRangeShifterDescription(unsigned long idx, std::string parameter)
bool getRangeShifterID(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