mlDcmDRTProtocolContextSequenceInterface.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
//
// NOTE: 
// This file has been generated automatically by
//   FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/convertDcmtkToML.py
// using the template file
//   FMEwork/ReleaseMeVis/Configuration/CodeGenerators/dcmtkToMLConverter/MLDcmtkAccessoriesNew/templates/DcmSequenceInterface.h
//
// Destination project: 
//   FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessoriesNew/DcmSequenceInterfaces
//
//----------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------
 
#ifndef __mlDcmDRTProtocolContextSequenceInterface_H
#define __mlDcmDRTProtocolContextSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTProtocolContextSequenceInterface.h" //DRTProtocolContextSequence
#include "mlDcmDRTConceptCodeSequenceInterface.h" //DRTConceptCodeSequence
#include "mlDcmDRTConceptNameCodeSequenceInterface.h" //DRTConceptNameCodeSequence
#include "mlDcmDRTContentItemModifierSequenceInterface.h" //DRTContentItemModifierSequence
#include "mlDcmDRTMeasurementUnitsCodeSequenceInterface.h" //DRTMeasurementUnitsCodeSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTProtocolContextSequenceInterface
{
  public:
 
    class MLDCMTKACCESSORIES_EXPORT Item
    {
    public:
 
      Item() { _dcmItem = DcmtkAccessories::createNewDicomTree(); }
 
      Item(DCMTree::TreePtr dcmItem) : _dcmItem(dcmItem) {}
 
      Item(const Item &copyDcmItem) : _dcmItem(copyDcmItem.getTreePtr()) {}
 
      Item &operator=(const Item &copyDcmItem){ _dcmItem = copyDcmItem.getTreePtr(); return *this; }
 
      virtual ~Item() {}
 
      DCMTree::TreePtr getTreePtr() const { return _dcmItem; }
      
      bool isValid() const { return _dcmItem.get() != nullptr; }
 
      
    // Date (0040,a121) vr=DA, vm=1, type=1C
    bool getDate(std::string& parameter) const;
    std::string getDateTag() const { return "(0040,a121)"; }
    bool setDate(std::string parameter);
    
    // DateTime (0040,a120) vr=DT, vm=1, type=1C
    bool getDateTime(std::string& parameter) const;
    std::string getDateTimeTag() const { return "(0040,a120)"; }
    bool setDateTime(std::string parameter);
    
    // NumericValue (0040,a30a) vr=DS, vm=1-n, type=1C
    bool getNumericValue(std::string& parameter) const;
    std::string getNumericValueTag() const { return "(0040,a30a)"; }
    bool setNumericValue(std::string parameter);
    
    // PersonName (0040,a123) vr=PN, vm=1, type=1C
    bool getPersonName(std::string& parameter) const;
    std::string getPersonNameTag() const { return "(0040,a123)"; }
    bool setPersonName(std::string parameter);
    
    // TextValue (0040,a160) vr=UT, vm=1, type=1C
    bool getTextValue(std::string& parameter) const;
    std::string getTextValueTag() const { return "(0040,a160)"; }
    bool setTextValue(std::string parameter);
    
    // Time (0040,a122) vr=TM, vm=1, type=1C
    bool getTime(std::string& parameter) const;
    std::string getTimeTag() const { return "(0040,a122)"; }
    bool setTime(std::string parameter);
    
    // UID (0040,a124) vr=UI, vm=1, type=1C
    bool getUID(std::string& parameter) const;
    std::string getUIDTag() const { return "(0040,a124)"; }
    bool setUID(std::string parameter);
    
    // ValueType (0040,a040) vr=CS, vm=1, type=1
    bool getValueType(std::string& parameter) const;
    std::string getValueTypeTag() const { return "(0040,a040)"; }
    bool setValueType(std::string parameter);
    
    // ConceptCodeSequence (0040,a168) vr=SQ, vm=1, type=1C
    DcmDRTConceptCodeSequenceInterface getConceptCodeSequence() const;
    std::string getConceptCodeSequenceTag() const { return std::string("(0040,a168)"); }
    void setConceptCodeSequence(DcmDRTConceptCodeSequenceInterface seq);
 
    // ConceptNameCodeSequence (0040,a043) vr=SQ, vm=1, type=1
    DcmDRTConceptNameCodeSequenceInterface getConceptNameCodeSequence() const;
    std::string getConceptNameCodeSequenceTag() const { return std::string("(0040,a043)"); }
    void setConceptNameCodeSequence(DcmDRTConceptNameCodeSequenceInterface seq);
 
    // ContentItemModifierSequence (0040,0441) vr=SQ, vm=1, type=3
    DcmDRTContentItemModifierSequenceInterface getContentItemModifierSequence() const;
    std::string getContentItemModifierSequenceTag() const { return std::string("(0040,0441)"); }
    void setContentItemModifierSequence(DcmDRTContentItemModifierSequenceInterface seq);
 
    // MeasurementUnitsCodeSequence (0040,08ea) vr=SQ, vm=1, type=1C
    DcmDRTMeasurementUnitsCodeSequenceInterface getMeasurementUnitsCodeSequence() const;
    std::string getMeasurementUnitsCodeSequenceTag() const { return std::string("(0040,08ea)"); }
    void setMeasurementUnitsCodeSequence(DcmDRTMeasurementUnitsCodeSequenceInterface seq);
 
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTProtocolContextSequenceInterface()  { }
    
    DcmDRTProtocolContextSequenceInterface(std::vector<DcmDRTProtocolContextSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTProtocolContextSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTProtocolContextSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTProtocolContextSequenceInterface() {} 
    // Date (0040,a121) vr=DA, vm=1, type=1C
    bool getDate(unsigned long idx, std::string& parameter) const;
    bool getDate(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDateTag() const { return "(0040,a121)"; }
    bool setDate(unsigned long idx, std::string parameter);
    
    // DateTime (0040,a120) vr=DT, vm=1, type=1C
    bool getDateTime(unsigned long idx, std::string& parameter) const;
    bool getDateTime(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getDateTimeTag() const { return "(0040,a120)"; }
    bool setDateTime(unsigned long idx, std::string parameter);
    
    // NumericValue (0040,a30a) vr=DS, vm=1-n, type=1C
    bool getNumericValue(unsigned long idx, std::string& parameter) const;
    bool getNumericValue(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getNumericValueTag() const { return "(0040,a30a)"; }
    bool setNumericValue(unsigned long idx, std::string parameter);
    
    // PersonName (0040,a123) vr=PN, vm=1, type=1C
    bool getPersonName(unsigned long idx, std::string& parameter) const;
    bool getPersonName(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPersonNameTag() const { return "(0040,a123)"; }
    bool setPersonName(unsigned long idx, std::string parameter);
    
    // TextValue (0040,a160) vr=UT, vm=1, type=1C
    bool getTextValue(unsigned long idx, std::string& parameter) const;
    bool getTextValue(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTextValueTag() const { return "(0040,a160)"; }
    bool setTextValue(unsigned long idx, std::string parameter);
    
    // Time (0040,a122) vr=TM, vm=1, type=1C
    bool getTime(unsigned long idx, std::string& parameter) const;
    bool getTime(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getTimeTag() const { return "(0040,a122)"; }
    bool setTime(unsigned long idx, std::string parameter);
    
    // UID (0040,a124) vr=UI, vm=1, type=1C
    bool getUID(unsigned long idx, std::string& parameter) const;
    bool getUID(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getUIDTag() const { return "(0040,a124)"; }
    bool setUID(unsigned long idx, std::string parameter);
    
    // ValueType (0040,a040) vr=CS, vm=1, type=1
    bool getValueType(unsigned long idx, std::string& parameter) const;
    bool getValueType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getValueTypeTag() const { return "(0040,a040)"; }
    bool setValueType(unsigned long idx, std::string parameter);
     
    // ConceptCodeSequence (0040,a168) vr=SQ, vm=1, type=1C
    DcmDRTConceptCodeSequenceInterface getConceptCodeSequence(unsigned long idx) const;
    std::string getConceptCodeSequenceTag() const { return std::string("(0040,a168)"); }
    void setConceptCodeSequence(DcmDRTConceptCodeSequenceInterface seq, unsigned long idx);
 
    // ConceptNameCodeSequence (0040,a043) vr=SQ, vm=1, type=1
    DcmDRTConceptNameCodeSequenceInterface getConceptNameCodeSequence(unsigned long idx) const;
    std::string getConceptNameCodeSequenceTag() const { return std::string("(0040,a043)"); }
    void setConceptNameCodeSequence(DcmDRTConceptNameCodeSequenceInterface seq, unsigned long idx);
 
    // ContentItemModifierSequence (0040,0441) vr=SQ, vm=1, type=3
    DcmDRTContentItemModifierSequenceInterface getContentItemModifierSequence(unsigned long idx) const;
    std::string getContentItemModifierSequenceTag() const { return std::string("(0040,0441)"); }
    void setContentItemModifierSequence(DcmDRTContentItemModifierSequenceInterface seq, unsigned long idx);
 
    // MeasurementUnitsCodeSequence (0040,08ea) vr=SQ, vm=1, type=1C
    DcmDRTMeasurementUnitsCodeSequenceInterface getMeasurementUnitsCodeSequence(unsigned long idx) const;
    std::string getMeasurementUnitsCodeSequenceTag() const { return std::string("(0040,08ea)"); }
    void setMeasurementUnitsCodeSequence(DcmDRTMeasurementUnitsCodeSequenceInterface seq, unsigned long idx);
 
    
    void setSequence(std::vector<DcmDRTProtocolContextSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTProtocolContextSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTProtocolContextSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTProtocolContextSequenceInterface::Item();
    }
    
    DcmDRTProtocolContextSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTProtocolContextSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTProtocolContextSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTProtocolContextSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTProtocolContextSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTProtocolContextSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTProtocolContextSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTProtocolContextSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */