mlDcmDRTModalityLUTSequenceInterface.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 __mlDcmDRTModalityLUTSequenceInterface_H
#define __mlDcmDRTModalityLUTSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTModalityLUTSequenceInterface.h" //DRTModalityLUTSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTModalityLUTSequenceInterface
{
  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; }
 
      
    // LUTDescriptor (0028,3002) vr=US_SS, vm=3, type=1C
    bool getLUTDescriptor(MLuint16& parameter) const;
    std::string getLUTDescriptorTag() const { return "(0028,3002)"; }
    bool setLUTDescriptor(MLuint16 parameter);
    
    // LUTExplanation (0028,3003) vr=LO, vm=1, type=3
    bool getLUTExplanation(std::string& parameter) const;
    std::string getLUTExplanationTag() const { return "(0028,3003)"; }
    bool setLUTExplanation(std::string parameter);
    
    // ModalityLUTType (0028,3004) vr=LO, vm=1, type=1C
    bool getModalityLUTType(std::string& parameter) const;
    std::string getModalityLUTTypeTag() const { return "(0028,3004)"; }
    bool setModalityLUTType(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTModalityLUTSequenceInterface()  { }
    
    DcmDRTModalityLUTSequenceInterface(std::vector<DcmDRTModalityLUTSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTModalityLUTSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTModalityLUTSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTModalityLUTSequenceInterface() {} 
    // LUTDescriptor (0028,3002) vr=US_SS, vm=3, type=1C
    bool getLUTDescriptor(unsigned long idx, MLuint16& parameter) const;
    bool getLUTDescriptor(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getLUTDescriptorTag() const { return "(0028,3002)"; }
    bool setLUTDescriptor(unsigned long idx, MLuint16 parameter);
    
    // LUTExplanation (0028,3003) vr=LO, vm=1, type=3
    bool getLUTExplanation(unsigned long idx, std::string& parameter) const;
    bool getLUTExplanation(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getLUTExplanationTag() const { return "(0028,3003)"; }
    bool setLUTExplanation(unsigned long idx, std::string parameter);
    
    // ModalityLUTType (0028,3004) vr=LO, vm=1, type=1C
    bool getModalityLUTType(unsigned long idx, std::string& parameter) const;
    bool getModalityLUTType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getModalityLUTTypeTag() const { return "(0028,3004)"; }
    bool setModalityLUTType(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTModalityLUTSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTModalityLUTSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTModalityLUTSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTModalityLUTSequenceInterface::Item();
    }
    
    DcmDRTModalityLUTSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTModalityLUTSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTModalityLUTSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTModalityLUTSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTModalityLUTSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTModalityLUTSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTModalityLUTSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTModalityLUTSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */