MeVisLab Toolbox Reference
mlDcmDRTContrastBolusAdministrationRouteSequenceInterface.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 __mlDcmDRTContrastBolusAdministrationRouteSequenceInterface_H
24#define __mlDcmDRTContrastBolusAdministrationRouteSequenceInterface_H
25
26// Local includes
27#include "mlDcmtkAccessories.h"
28
29// Dcmtk includes
30//#include "mlDcmDRTContrastBolusAdministrationRouteSequenceInterface.h" //DRTContrastBolusAdministrationRouteSequence
31#include "mlDcmDRTAdditionalDrugSequenceInterface.h" //DRTAdditionalDrugSequence
32
33
34// ML includes
35#ifndef __mlModuleIncludes_H
36#include "mlModuleIncludes.h"
37#endif
38
40
41// ------------------------------------------------------------------
43// ------------------------------------------------------------------
45{
46 public:
47
49 {
50 public:
51
52 Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
53
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 // CodeMeaning (0008,0104) vr=LO, vm=1, type=1C
68 bool getCodeMeaning(std::string& parameter) const;
69 std::string getCodeMeaningTag() const { return "(0008,0104)"; }
70 bool setCodeMeaning(std::string parameter);
71
72 // CodeValue (0008,0100) vr=SH, vm=1, type=1C
73 bool getCodeValue(std::string& parameter) const;
74 std::string getCodeValueTag() const { return "(0008,0100)"; }
75 bool setCodeValue(std::string parameter);
76
77 // CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C
78 bool getCodingSchemeDesignator(std::string& parameter) const;
79 std::string getCodingSchemeDesignatorTag() const { return "(0008,0102)"; }
80 bool setCodingSchemeDesignator(std::string parameter);
81
82 // CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C
83 bool getCodingSchemeVersion(std::string& parameter) const;
84 std::string getCodingSchemeVersionTag() const { return "(0008,0103)"; }
85 bool setCodingSchemeVersion(std::string parameter);
86
87 // ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C
88 bool getContextGroupExtensionCreatorUID(std::string& parameter) const;
89 std::string getContextGroupExtensionCreatorUIDTag() const { return "(0008,010d)"; }
90 bool setContextGroupExtensionCreatorUID(std::string parameter);
91
92 // ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3
93 bool getContextGroupExtensionFlag(std::string& parameter) const;
94 std::string getContextGroupExtensionFlagTag() const { return "(0008,010b)"; }
95 bool setContextGroupExtensionFlag(std::string parameter);
96
97 // ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C
98 bool getContextGroupLocalVersion(std::string& parameter) const;
99 std::string getContextGroupLocalVersionTag() const { return "(0008,0107)"; }
100 bool setContextGroupLocalVersion(std::string parameter);
101
102 // ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C
103 bool getContextGroupVersion(std::string& parameter) const;
104 std::string getContextGroupVersionTag() const { return "(0008,0106)"; }
105 bool setContextGroupVersion(std::string parameter);
106
107 // ContextIdentifier (0008,010f) vr=CS, vm=1, type=3
108 bool getContextIdentifier(std::string& parameter) const;
109 std::string getContextIdentifierTag() const { return "(0008,010f)"; }
110 bool setContextIdentifier(std::string parameter);
111
112 // MappingResource (0008,0105) vr=CS, vm=1, type=1C
113 bool getMappingResource(std::string& parameter) const;
114 std::string getMappingResourceTag() const { return "(0008,0105)"; }
115 bool setMappingResource(std::string parameter);
116
117 // AdditionalDrugSequence (0018,002a) vr=SQ, vm=1, type=3
119 std::string getAdditionalDrugSequenceTag() const { return std::string("(0018,002a)"); }
121
122
123 private:
124
125 DCMTree::TreePtr _dcmItem;
126
127 };
128
130
132 DcmDRTContrastBolusAdministrationRouteSequenceInterface(std::vector<DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
133
140
143 // CodeMeaning (0008,0104) vr=LO, vm=1, type=1C
144 bool getCodeMeaning(unsigned long idx, std::string& parameter) const;
145 bool getCodeMeaning(DCMTree::TreePtr item, std::string& parameter) const;
146 std::string getCodeMeaningTag() const { return "(0008,0104)"; }
147 bool setCodeMeaning(unsigned long idx, std::string parameter);
148
149 // CodeValue (0008,0100) vr=SH, vm=1, type=1C
150 bool getCodeValue(unsigned long idx, std::string& parameter) const;
151 bool getCodeValue(DCMTree::TreePtr item, std::string& parameter) const;
152 std::string getCodeValueTag() const { return "(0008,0100)"; }
153 bool setCodeValue(unsigned long idx, std::string parameter);
154
155 // CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C
156 bool getCodingSchemeDesignator(unsigned long idx, std::string& parameter) const;
157 bool getCodingSchemeDesignator(DCMTree::TreePtr item, std::string& parameter) const;
158 std::string getCodingSchemeDesignatorTag() const { return "(0008,0102)"; }
159 bool setCodingSchemeDesignator(unsigned long idx, std::string parameter);
160
161 // CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C
162 bool getCodingSchemeVersion(unsigned long idx, std::string& parameter) const;
163 bool getCodingSchemeVersion(DCMTree::TreePtr item, std::string& parameter) const;
164 std::string getCodingSchemeVersionTag() const { return "(0008,0103)"; }
165 bool setCodingSchemeVersion(unsigned long idx, std::string parameter);
166
167 // ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C
168 bool getContextGroupExtensionCreatorUID(unsigned long idx, std::string& parameter) const;
169 bool getContextGroupExtensionCreatorUID(DCMTree::TreePtr item, std::string& parameter) const;
170 std::string getContextGroupExtensionCreatorUIDTag() const { return "(0008,010d)"; }
171 bool setContextGroupExtensionCreatorUID(unsigned long idx, std::string parameter);
172
173 // ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3
174 bool getContextGroupExtensionFlag(unsigned long idx, std::string& parameter) const;
175 bool getContextGroupExtensionFlag(DCMTree::TreePtr item, std::string& parameter) const;
176 std::string getContextGroupExtensionFlagTag() const { return "(0008,010b)"; }
177 bool setContextGroupExtensionFlag(unsigned long idx, std::string parameter);
178
179 // ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C
180 bool getContextGroupLocalVersion(unsigned long idx, std::string& parameter) const;
181 bool getContextGroupLocalVersion(DCMTree::TreePtr item, std::string& parameter) const;
182 std::string getContextGroupLocalVersionTag() const { return "(0008,0107)"; }
183 bool setContextGroupLocalVersion(unsigned long idx, std::string parameter);
184
185 // ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C
186 bool getContextGroupVersion(unsigned long idx, std::string& parameter) const;
187 bool getContextGroupVersion(DCMTree::TreePtr item, std::string& parameter) const;
188 std::string getContextGroupVersionTag() const { return "(0008,0106)"; }
189 bool setContextGroupVersion(unsigned long idx, std::string parameter);
190
191 // ContextIdentifier (0008,010f) vr=CS, vm=1, type=3
192 bool getContextIdentifier(unsigned long idx, std::string& parameter) const;
193 bool getContextIdentifier(DCMTree::TreePtr item, std::string& parameter) const;
194 std::string getContextIdentifierTag() const { return "(0008,010f)"; }
195 bool setContextIdentifier(unsigned long idx, std::string parameter);
196
197 // MappingResource (0008,0105) vr=CS, vm=1, type=1C
198 bool getMappingResource(unsigned long idx, std::string& parameter) const;
199 bool getMappingResource(DCMTree::TreePtr item, std::string& parameter) const;
200 std::string getMappingResourceTag() const { return "(0008,0105)"; }
201 bool setMappingResource(unsigned long idx, std::string parameter);
202
203 // AdditionalDrugSequence (0018,002a) vr=SQ, vm=1, type=3
205 std::string getAdditionalDrugSequenceTag() const { return std::string("(0018,002a)"); }
207
208
211 void setSequence(std::vector<DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item> dcmSequence) {
212 _itemVec = dcmSequence;
213 }
214
217 std::vector<DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item> getSequence() const {
218 return _itemVec;
219 }
220
223 bool hasSequence() const {
224 return (_itemVec.size() != 0);
225 }
226
230 return static_cast<MLint>(_itemVec.size());
231 }
232
236 if (_itemVec.size() > idx) {
237 return _itemVec[idx];
238 }
240 }
241
248
252
255 bool insertItem(const size_t idx) {
256 if (_itemVec.size() > idx) {
257 std::vector<DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item>::iterator it = _itemVec.begin();
258 std::advance(it, idx);
260 return true;
261 }
262 return false;
263 }
264
267 bool removeItem(const size_t idx) {
268 if ( _itemVec.size() > idx ) {
269 std::vector<DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item>::iterator it = _itemVec.begin();
270 std::advance(it, idx);
271 _itemVec.erase(it);
272 return true;
273 }
274 return false;
275 }
276
277 protected:
279 std::vector<DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item> _itemVec;
280};
281
283
284#endif // __mlDcmDRTContrastBolusAdministrationRouteSequenceInterface_H
285
286/* MeVis-Hidden-Components-Start */
287/* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
Class to provide access to DRTAdditionalDrugSequence.
void setAdditionalDrugSequence(DcmDRTAdditionalDrugSequenceInterface seq)
bool getContextGroupExtensionCreatorUID(std::string &parameter) const
DcmDRTAdditionalDrugSequenceInterface getAdditionalDrugSequence() const
Class to provide access to DRTContrastBolusAdministrationRouteSequence.
bool getContextGroupVersion(unsigned long idx, std::string &parameter) const
void setSequence(std::vector< DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item > dcmSequence)
Set the DRTContrastBolusAdministrationRouteSequence this interface class provides access to.
DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool setContextGroupVersion(unsigned long idx, std::string parameter)
bool getCodingSchemeDesignator(unsigned long idx, std::string &parameter) const
DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item & addItem()
Adds a new item to the sequence.
bool getMappingResource(unsigned long idx, std::string &parameter) const
bool getContextGroupExtensionFlag(DCMTree::TreePtr item, std::string &parameter) const
bool setContextGroupLocalVersion(unsigned long idx, std::string parameter)
bool getCodingSchemeVersion(unsigned long idx, std::string &parameter) const
bool setContextGroupExtensionCreatorUID(unsigned long idx, std::string parameter)
bool getContextGroupVersion(DCMTree::TreePtr item, std::string &parameter) const
bool getMappingResource(DCMTree::TreePtr item, std::string &parameter) const
bool setContextIdentifier(unsigned long idx, std::string parameter)
bool setCodingSchemeDesignator(unsigned long idx, std::string parameter)
std::vector< DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item > getSequence() const
Return the DRTContrastBolusAdministrationRouteSequence this interface class provides access to.
DcmDRTContrastBolusAdministrationRouteSequenceInterface(std::vector< DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item > dcmSequence)
Default Constructor.
bool getContextIdentifier(unsigned long idx, std::string &parameter) const
bool getContextGroupExtensionCreatorUID(unsigned long idx, std::string &parameter) const
bool getCodingSchemeVersion(DCMTree::TreePtr item, std::string &parameter) const
std::vector< DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
void addItem(DcmDRTContrastBolusAdministrationRouteSequenceInterface::Item newItem)
bool getCodeValue(unsigned long idx, std::string &parameter) const
bool getContextGroupExtensionCreatorUID(DCMTree::TreePtr item, std::string &parameter) const
bool setContextGroupExtensionFlag(unsigned long idx, std::string parameter)
bool hasSequence() const
Check if the DRTContrastBolusAdministrationRouteSequence is set.
bool getCodeMeaning(DCMTree::TreePtr item, std::string &parameter) const
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
void setAdditionalDrugSequence(DcmDRTAdditionalDrugSequenceInterface seq, unsigned long idx)
bool setCodeValue(unsigned long idx, std::string parameter)
bool getCodeValue(DCMTree::TreePtr item, std::string &parameter) const
bool getContextIdentifier(DCMTree::TreePtr item, std::string &parameter) const
bool getCodeMeaning(unsigned long idx, std::string &parameter) const
bool getContextGroupLocalVersion(DCMTree::TreePtr item, std::string &parameter) const
DcmDRTAdditionalDrugSequenceInterface getAdditionalDrugSequence(unsigned long idx) const
bool setCodeMeaning(unsigned long idx, std::string parameter)
bool setCodingSchemeVersion(unsigned long idx, std::string parameter)
bool getCodingSchemeDesignator(DCMTree::TreePtr item, std::string &parameter) const
bool setMappingResource(unsigned long idx, std::string parameter)
bool getContextGroupExtensionFlag(unsigned long idx, std::string &parameter) const
bool getContextGroupLocalVersion(unsigned long idx, std::string &parameter) const
Class to provide access to DRTAdditionalDrugSequence.
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