MeVisLab Toolbox Reference
mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.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 __mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface_H
24#define __mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface_H
25
26// Local includes
27#include "mlDcmtkAccessories.h"
28
29// Dcmtk includes
30//#include "mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface.h" //DRTApplicatorSequenceInRTIonBeamsModule
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 // ApplicatorDescription (300a,010a) vr=LO, vm=1, type=3
72 bool getApplicatorDescription(std::string& parameter) const;
73 std::string getApplicatorDescriptionTag() const { return "(300a,010a)"; }
74 bool setApplicatorDescription(std::string parameter);
75
76 // ApplicatorID (300a,0108) vr=SH, vm=1, type=1
77 bool getApplicatorID(std::string& parameter) const;
78 std::string getApplicatorIDTag() const { return "(300a,0108)"; }
79 bool setApplicatorID(std::string parameter);
80
81 // ApplicatorType (300a,0109) vr=CS, vm=1, type=1
82 bool getApplicatorType(std::string& parameter) const;
83 std::string getApplicatorTypeTag() const { return "(300a,0109)"; }
84 bool setApplicatorType(std::string parameter);
85
86
87 private:
88
89 DCMTree::TreePtr _dcmItem;
90
91 };
92
94
96 DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface(std::vector<DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
97
104
107 // AccessoryCode (300a,00f9) vr=LO, vm=1, type=3
108 bool getAccessoryCode(unsigned long idx, std::string& parameter) const;
109 bool getAccessoryCode(DCMTree::TreePtr item, std::string& parameter) const;
110 std::string getAccessoryCodeTag() const { return "(300a,00f9)"; }
111 bool setAccessoryCode(unsigned long idx, std::string parameter);
112
113 // ApplicatorDescription (300a,010a) vr=LO, vm=1, type=3
114 bool getApplicatorDescription(unsigned long idx, std::string& parameter) const;
115 bool getApplicatorDescription(DCMTree::TreePtr item, std::string& parameter) const;
116 std::string getApplicatorDescriptionTag() const { return "(300a,010a)"; }
117 bool setApplicatorDescription(unsigned long idx, std::string parameter);
118
119 // ApplicatorID (300a,0108) vr=SH, vm=1, type=1
120 bool getApplicatorID(unsigned long idx, std::string& parameter) const;
121 bool getApplicatorID(DCMTree::TreePtr item, std::string& parameter) const;
122 std::string getApplicatorIDTag() const { return "(300a,0108)"; }
123 bool setApplicatorID(unsigned long idx, std::string parameter);
124
125 // ApplicatorType (300a,0109) vr=CS, vm=1, type=1
126 bool getApplicatorType(unsigned long idx, std::string& parameter) const;
127 bool getApplicatorType(DCMTree::TreePtr item, std::string& parameter) const;
128 std::string getApplicatorTypeTag() const { return "(300a,0109)"; }
129 bool setApplicatorType(unsigned long idx, std::string parameter);
130
131
134 void setSequence(std::vector<DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item> dcmSequence) {
135 _itemVec = dcmSequence;
136 }
137
140 std::vector<DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item> getSequence() const {
141 return _itemVec;
142 }
143
146 bool hasSequence() const {
147 return (_itemVec.size() != 0);
148 }
149
153 return static_cast<MLint>(_itemVec.size());
154 }
155
159 if (_itemVec.size() > idx) {
160 return _itemVec[idx];
161 }
163 }
164
171
175
178 bool insertItem(const size_t idx) {
179 if (_itemVec.size() > idx) {
180 std::vector<DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item>::iterator it = _itemVec.begin();
181 std::advance(it, idx);
183 return true;
184 }
185 return false;
186 }
187
190 bool removeItem(const size_t idx) {
191 if ( _itemVec.size() > idx ) {
192 std::vector<DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item>::iterator it = _itemVec.begin();
193 std::advance(it, idx);
194 _itemVec.erase(it);
195 return true;
196 }
197 return false;
198 }
199
200 protected:
202 std::vector<DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item> _itemVec;
203};
204
206
207#endif // __mlDcmDRTApplicatorSequenceInRTIonBeamsModuleInterface_H
208
209/* MeVis-Hidden-Components-Start */
210/* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
bool getApplicatorDescription(std::string &parameter) const
Class to provide access to DRTApplicatorSequenceInRTIonBeamsModule.
bool getAccessoryCode(DCMTree::TreePtr item, std::string &parameter) const
bool getApplicatorID(unsigned long idx, std::string &parameter) const
bool hasSequence() const
Check if the DRTApplicatorSequenceInRTIonBeamsModule is set.
bool getApplicatorType(DCMTree::TreePtr item, std::string &parameter) const
DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface(std::vector< DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
Default Constructor.
bool getApplicatorDescription(DCMTree::TreePtr item, std::string &parameter) const
bool getApplicatorID(DCMTree::TreePtr item, std::string &parameter) const
void addItem(DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item newItem)
std::vector< DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item > getSequence() const
Return the DRTApplicatorSequenceInRTIonBeamsModule 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.
DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
void setSequence(std::vector< DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item > dcmSequence)
Set the DRTApplicatorSequenceInRTIonBeamsModule this interface class provides access to.
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
bool getApplicatorDescription(unsigned long idx, std::string &parameter) const
bool setApplicatorID(unsigned long idx, std::string parameter)
bool getApplicatorType(unsigned long idx, std::string &parameter) const
bool setApplicatorType(unsigned long idx, std::string parameter)
bool setApplicatorDescription(unsigned long idx, std::string parameter)
bool setAccessoryCode(unsigned long idx, std::string parameter)
bool getAccessoryCode(unsigned long idx, std::string &parameter) const
std::vector< DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
DcmDRTApplicatorSequenceInRTIonBeamsModuleInterface::Item & addItem()
Adds a new item to the sequence.
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