MeVisLab Toolbox Reference
mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.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 __mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface_H
24 #define __mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface_H
25 
26 // Local includes
27 #include "mlDcmtkAccessories.h"
28 
29 // Dcmtk includes
30 //#include "mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h" //DRTPhysiciansReadingStudyIdentificationSequence
31 #include "mlDcmDRTInstitutionCodeSequenceInterface.h" //DRTInstitutionCodeSequence
32 #include "mlDcmDRTPersonIdentificationCodeSequenceInterface.h" //DRTPersonIdentificationCodeSequence
33 
34 
35 // ML includes
36 #ifndef __mlModuleIncludes_H
37 #include "mlModuleIncludes.h"
38 #endif
39 
40 ML_START_NAMESPACE
41 
42 // ------------------------------------------------------------------
44 // ------------------------------------------------------------------
46 {
47  public:
48 
50  {
51  public:
52 
53  Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
54 
55  Item(DCMTree::TreePtr dcmItem) : _dcmItem(dcmItem) {}
56 
57  Item(const Item &copyDcmItem) : _dcmItem(copyDcmItem.getTreePtr()) {}
58 
59  Item &operator=(const Item &copyDcmItem){ _dcmItem = copyDcmItem.getTreePtr(); return *this; }
60 
61  virtual ~Item() {}
62 
63  DCMTree::TreePtr getTreePtr() const { return _dcmItem; }
64 
65  bool isValid() const { return _dcmItem.get() != nullptr; }
66 
67 
68  // InstitutionAddress (0008,0081) vr=ST, vm=1, type=3
69  bool getInstitutionAddress(std::string& parameter) const;
70  std::string getInstitutionAddressTag() const { return "(0008,0081)"; }
71  bool setInstitutionAddress(std::string parameter);
72 
73  // InstitutionName (0008,0080) vr=LO, vm=1, type=1C
74  bool getInstitutionName(std::string& parameter) const;
75  std::string getInstitutionNameTag() const { return "(0008,0080)"; }
76  bool setInstitutionName(std::string parameter);
77 
78  // PersonAddress (0040,1102) vr=ST, vm=1, type=3
79  bool getPersonAddress(std::string& parameter) const;
80  std::string getPersonAddressTag() const { return "(0040,1102)"; }
81  bool setPersonAddress(std::string parameter);
82 
83  // PersonTelephoneNumbers (0040,1103) vr=LO, vm=1-n, type=3
84  bool getPersonTelephoneNumbers(std::string& parameter) const;
85  std::string getPersonTelephoneNumbersTag() const { return "(0040,1103)"; }
86  bool setPersonTelephoneNumbers(std::string parameter);
87 
88  // InstitutionCodeSequence (0008,0082) vr=SQ, vm=1, type=1C
90  std::string getInstitutionCodeSequenceTag() const { return std::string("(0008,0082)"); }
92 
93  // PersonIdentificationCodeSequence (0040,1101) vr=SQ, vm=1, type=1
95  std::string getPersonIdentificationCodeSequenceTag() const { return std::string("(0040,1101)"); }
97 
98 
99  private:
100 
101  DCMTree::TreePtr _dcmItem;
102 
103  };
104 
106 
108  DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface(std::vector<DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
109 
111  for(size_t i=0; i < treePtrSeq.size(); i++)
112  {
114  }
115  }
116 
119  // InstitutionAddress (0008,0081) vr=ST, vm=1, type=3
120  bool getInstitutionAddress(unsigned long idx, std::string& parameter) const;
121  bool getInstitutionAddress(DCMTree::TreePtr item, std::string& parameter) const;
122  std::string getInstitutionAddressTag() const { return "(0008,0081)"; }
123  bool setInstitutionAddress(unsigned long idx, std::string parameter);
124 
125  // InstitutionName (0008,0080) vr=LO, vm=1, type=1C
126  bool getInstitutionName(unsigned long idx, std::string& parameter) const;
127  bool getInstitutionName(DCMTree::TreePtr item, std::string& parameter) const;
128  std::string getInstitutionNameTag() const { return "(0008,0080)"; }
129  bool setInstitutionName(unsigned long idx, std::string parameter);
130 
131  // PersonAddress (0040,1102) vr=ST, vm=1, type=3
132  bool getPersonAddress(unsigned long idx, std::string& parameter) const;
133  bool getPersonAddress(DCMTree::TreePtr item, std::string& parameter) const;
134  std::string getPersonAddressTag() const { return "(0040,1102)"; }
135  bool setPersonAddress(unsigned long idx, std::string parameter);
136 
137  // PersonTelephoneNumbers (0040,1103) vr=LO, vm=1-n, type=3
138  bool getPersonTelephoneNumbers(unsigned long idx, std::string& parameter) const;
139  bool getPersonTelephoneNumbers(DCMTree::TreePtr item, std::string& parameter) const;
140  std::string getPersonTelephoneNumbersTag() const { return "(0040,1103)"; }
141  bool setPersonTelephoneNumbers(unsigned long idx, std::string parameter);
142 
143  // InstitutionCodeSequence (0008,0082) vr=SQ, vm=1, type=1C
145  std::string getInstitutionCodeSequenceTag() const { return std::string("(0008,0082)"); }
147 
148  // PersonIdentificationCodeSequence (0040,1101) vr=SQ, vm=1, type=1
150  std::string getPersonIdentificationCodeSequenceTag() const { return std::string("(0040,1101)"); }
152 
153 
156  void setSequence(std::vector<DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item> dcmSequence) {
157  _itemVec = dcmSequence;
158  }
159 
162  std::vector<DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item> getSequence() const {
163  return _itemVec;
164  }
165 
168  bool hasSequence() const {
169  return (_itemVec.size() != 0);
170  }
171 
175  return static_cast<MLint>(_itemVec.size());
176  }
177 
181  if (_itemVec.size() > idx) {
182  return _itemVec[idx];
183  }
185  }
186 
191  return _itemVec[_itemVec.size()-1];
192  }
193 
195  _itemVec.push_back(newItem);
196  }
197 
200  bool insertItem(const size_t idx) {
201  if (_itemVec.size() > idx) {
202  std::vector<DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item>::iterator it = _itemVec.begin();
203  std::advance(it, idx);
205  return true;
206  }
207  return false;
208  }
209 
212  bool removeItem(const size_t idx) {
213  if ( _itemVec.size() > idx ) {
214  std::vector<DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item>::iterator it = _itemVec.begin();
215  std::advance(it, idx);
216  _itemVec.erase(it);
217  return true;
218  }
219  return false;
220  }
221 
222  protected:
224  std::vector<DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item> _itemVec;
225 };
226 
227 ML_END_NAMESPACE
228 
229 #endif // __mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface_H
230 
231 /* MeVis-Hidden-Components-Start */
232 /* MeVis-Hidden-Components-End */
#define MLDCMTKACCESSORIES_EXPORT
Class to provide access to DRTInstitutionCodeSequence.
Class to provide access to DRTPersonIdentificationCodeSequence.
void setPersonIdentificationCodeSequence(DcmDRTPersonIdentificationCodeSequenceInterface seq)
DcmDRTInstitutionCodeSequenceInterface getInstitutionCodeSequence() const
DcmDRTPersonIdentificationCodeSequenceInterface getPersonIdentificationCodeSequence() const
void setInstitutionCodeSequence(DcmDRTInstitutionCodeSequenceInterface seq)
Class to provide access to DRTPhysiciansReadingStudyIdentificationSequence.
DcmDRTInstitutionCodeSequenceInterface getInstitutionCodeSequence(unsigned long idx) const
void setSequence(std::vector< DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item > dcmSequence)
Set the DRTPhysiciansReadingStudyIdentificationSequence this interface class provides access to.
bool setInstitutionName(unsigned long idx, std::string parameter)
bool getPersonTelephoneNumbers(unsigned long idx, std::string &parameter) const
bool setPersonAddress(unsigned long idx, std::string parameter)
DcmDRTPersonIdentificationCodeSequenceInterface getPersonIdentificationCodeSequence(unsigned long idx) const
std::vector< DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item > getSequence() const
Return the DRTPhysiciansReadingStudyIdentificationSequence this interface class provides access to.
bool setInstitutionAddress(unsigned long idx, std::string parameter)
std::vector< DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item > _itemVec
Reference to the wrapped DICOM tree pointer vector.
void addItem(DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item newItem)
void setPersonIdentificationCodeSequence(DcmDRTPersonIdentificationCodeSequenceInterface seq, unsigned long idx)
bool setPersonTelephoneNumbers(unsigned long idx, std::string parameter)
DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface(std::vector< DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item > dcmSequence)
Default Constructor.
bool getInstitutionAddress(unsigned long idx, std::string &parameter) const
bool getPersonAddress(DCMTree::TreePtr item, std::string &parameter) const
void setInstitutionCodeSequence(DcmDRTInstitutionCodeSequenceInterface seq, unsigned long idx)
bool hasSequence() const
Check if the DRTPhysiciansReadingStudyIdentificationSequence is set.
bool getPersonAddress(unsigned long idx, std::string &parameter) const
bool getInstitutionName(DCMTree::TreePtr item, std::string &parameter) const
bool getInstitutionAddress(DCMTree::TreePtr item, std::string &parameter) const
MLint getNumberOfItems() const
Return number of items the internal sequence consists of.
DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item & addItem()
Adds a new item to the sequence.
DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item getItem(const size_t idx) const
Gets the item at the indicated position.
bool getInstitutionName(unsigned long idx, std::string &parameter) const
bool getPersonTelephoneNumbers(DCMTree::TreePtr item, std::string &parameter) const
Class to provide access to DRTInstitutionCodeSequence.
Class to provide access to DRTPersonIdentificationCodeSequence.
Class collecting some DICOM helper functionality explicitly for dcmtk.
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition: mlTypeDefs.h:578
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:70