mlDcmDRTIconImageSequenceInterface.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 __mlDcmDRTIconImageSequenceInterface_H
#define __mlDcmDRTIconImageSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTIconImageSequenceInterface.h" //DRTIconImageSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTIconImageSequenceInterface
{
  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; }
 
      
    // BitsAllocated (0028,0100) vr=US, vm=1, type=1
    bool getBitsAllocated(MLuint16& parameter) const;
    std::string getBitsAllocatedTag() const { return "(0028,0100)"; }
    bool setBitsAllocated(MLuint16 parameter);
    
    // BitsStored (0028,0101) vr=US, vm=1, type=1
    bool getBitsStored(MLuint16& parameter) const;
    std::string getBitsStoredTag() const { return "(0028,0101)"; }
    bool setBitsStored(MLuint16 parameter);
    
    // BluePaletteColorLookupTableDescriptor (0028,1103) vr=US_SS, vm=3, type=1C
    bool getBluePaletteColorLookupTableDescriptor(MLuint16& parameter) const;
    std::string getBluePaletteColorLookupTableDescriptorTag() const { return "(0028,1103)"; }
    bool setBluePaletteColorLookupTableDescriptor(MLuint16 parameter);
    
    // Columns (0028,0011) vr=US, vm=1, type=1
    bool getColumns(MLuint16& parameter) const;
    std::string getColumnsTag() const { return "(0028,0011)"; }
    bool setColumns(MLuint16 parameter);
    
    // GreenPaletteColorLookupTableDescriptor (0028,1102) vr=US_SS, vm=3, type=1C
    bool getGreenPaletteColorLookupTableDescriptor(MLuint16& parameter) const;
    std::string getGreenPaletteColorLookupTableDescriptorTag() const { return "(0028,1102)"; }
    bool setGreenPaletteColorLookupTableDescriptor(MLuint16 parameter);
    
    // HighBit (0028,0102) vr=US, vm=1, type=1
    bool getHighBit(MLuint16& parameter) const;
    std::string getHighBitTag() const { return "(0028,0102)"; }
    bool setHighBit(MLuint16 parameter);
    
    // ICCProfile (0028,2000) vr=OB, vm=1, type=3
    bool getICCProfile(int& parameter) const;
    std::string getICCProfileTag() const { return "(0028,2000)"; }
    bool setICCProfile(int parameter);
    
    // LargestImagePixelValue (0028,0107) vr=US_SS, vm=1, type=3
    bool getLargestImagePixelValue(MLuint16& parameter) const;
    std::string getLargestImagePixelValueTag() const { return "(0028,0107)"; }
    bool setLargestImagePixelValue(MLuint16 parameter);
    
    // PhotometricInterpretation (0028,0004) vr=CS, vm=1, type=1
    bool getPhotometricInterpretation(std::string& parameter) const;
    std::string getPhotometricInterpretationTag() const { return "(0028,0004)"; }
    bool setPhotometricInterpretation(std::string parameter);
    
    // PixelAspectRatio (0028,0034) vr=IS, vm=2, type=1C
    bool getPixelAspectRatio(std::string& parameter) const;
    std::string getPixelAspectRatioTag() const { return "(0028,0034)"; }
    bool setPixelAspectRatio(std::string parameter);
    
    // PixelRepresentation (0028,0103) vr=US, vm=1, type=1
    bool getPixelRepresentation(MLuint16& parameter) const;
    std::string getPixelRepresentationTag() const { return "(0028,0103)"; }
    bool setPixelRepresentation(MLuint16 parameter);
    
    // PlanarConfiguration (0028,0006) vr=US, vm=1, type=1C
    bool getPlanarConfiguration(MLuint16& parameter) const;
    std::string getPlanarConfigurationTag() const { return "(0028,0006)"; }
    bool setPlanarConfiguration(MLuint16 parameter);
    
    // RedPaletteColorLookupTableDescriptor (0028,1101) vr=US_SS, vm=3, type=1C
    bool getRedPaletteColorLookupTableDescriptor(MLuint16& parameter) const;
    std::string getRedPaletteColorLookupTableDescriptorTag() const { return "(0028,1101)"; }
    bool setRedPaletteColorLookupTableDescriptor(MLuint16 parameter);
    
    // Rows (0028,0010) vr=US, vm=1, type=1
    bool getRows(MLuint16& parameter) const;
    std::string getRowsTag() const { return "(0028,0010)"; }
    bool setRows(MLuint16 parameter);
    
    // SamplesPerPixel (0028,0002) vr=US, vm=1, type=1
    bool getSamplesPerPixel(MLuint16& parameter) const;
    std::string getSamplesPerPixelTag() const { return "(0028,0002)"; }
    bool setSamplesPerPixel(MLuint16 parameter);
    
    // SmallestImagePixelValue (0028,0106) vr=US_SS, vm=1, type=3
    bool getSmallestImagePixelValue(MLuint16& parameter) const;
    std::string getSmallestImagePixelValueTag() const { return "(0028,0106)"; }
    bool setSmallestImagePixelValue(MLuint16 parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTIconImageSequenceInterface()  { }
    
    DcmDRTIconImageSequenceInterface(std::vector<DcmDRTIconImageSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTIconImageSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTIconImageSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTIconImageSequenceInterface() {} 
    // BitsAllocated (0028,0100) vr=US, vm=1, type=1
    bool getBitsAllocated(unsigned long idx, MLuint16& parameter) const;
    bool getBitsAllocated(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getBitsAllocatedTag() const { return "(0028,0100)"; }
    bool setBitsAllocated(unsigned long idx, MLuint16 parameter);
    
    // BitsStored (0028,0101) vr=US, vm=1, type=1
    bool getBitsStored(unsigned long idx, MLuint16& parameter) const;
    bool getBitsStored(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getBitsStoredTag() const { return "(0028,0101)"; }
    bool setBitsStored(unsigned long idx, MLuint16 parameter);
    
    // BluePaletteColorLookupTableDescriptor (0028,1103) vr=US_SS, vm=3, type=1C
    bool getBluePaletteColorLookupTableDescriptor(unsigned long idx, MLuint16& parameter) const;
    bool getBluePaletteColorLookupTableDescriptor(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getBluePaletteColorLookupTableDescriptorTag() const { return "(0028,1103)"; }
    bool setBluePaletteColorLookupTableDescriptor(unsigned long idx, MLuint16 parameter);
    
    // Columns (0028,0011) vr=US, vm=1, type=1
    bool getColumns(unsigned long idx, MLuint16& parameter) const;
    bool getColumns(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getColumnsTag() const { return "(0028,0011)"; }
    bool setColumns(unsigned long idx, MLuint16 parameter);
    
    // GreenPaletteColorLookupTableDescriptor (0028,1102) vr=US_SS, vm=3, type=1C
    bool getGreenPaletteColorLookupTableDescriptor(unsigned long idx, MLuint16& parameter) const;
    bool getGreenPaletteColorLookupTableDescriptor(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getGreenPaletteColorLookupTableDescriptorTag() const { return "(0028,1102)"; }
    bool setGreenPaletteColorLookupTableDescriptor(unsigned long idx, MLuint16 parameter);
    
    // HighBit (0028,0102) vr=US, vm=1, type=1
    bool getHighBit(unsigned long idx, MLuint16& parameter) const;
    bool getHighBit(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getHighBitTag() const { return "(0028,0102)"; }
    bool setHighBit(unsigned long idx, MLuint16 parameter);
    
    // ICCProfile (0028,2000) vr=OB, vm=1, type=3
    bool getICCProfile(unsigned long idx, int& parameter) const;
    bool getICCProfile(DCMTree::TreePtr item, int& parameter) const;
    std::string getICCProfileTag() const { return "(0028,2000)"; }
    bool setICCProfile(unsigned long idx, int parameter);
    
    // LargestImagePixelValue (0028,0107) vr=US_SS, vm=1, type=3
    bool getLargestImagePixelValue(unsigned long idx, MLuint16& parameter) const;
    bool getLargestImagePixelValue(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getLargestImagePixelValueTag() const { return "(0028,0107)"; }
    bool setLargestImagePixelValue(unsigned long idx, MLuint16 parameter);
    
    // PhotometricInterpretation (0028,0004) vr=CS, vm=1, type=1
    bool getPhotometricInterpretation(unsigned long idx, std::string& parameter) const;
    bool getPhotometricInterpretation(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPhotometricInterpretationTag() const { return "(0028,0004)"; }
    bool setPhotometricInterpretation(unsigned long idx, std::string parameter);
    
    // PixelAspectRatio (0028,0034) vr=IS, vm=2, type=1C
    bool getPixelAspectRatio(unsigned long idx, std::string& parameter) const;
    bool getPixelAspectRatio(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getPixelAspectRatioTag() const { return "(0028,0034)"; }
    bool setPixelAspectRatio(unsigned long idx, std::string parameter);
    
    // PixelRepresentation (0028,0103) vr=US, vm=1, type=1
    bool getPixelRepresentation(unsigned long idx, MLuint16& parameter) const;
    bool getPixelRepresentation(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getPixelRepresentationTag() const { return "(0028,0103)"; }
    bool setPixelRepresentation(unsigned long idx, MLuint16 parameter);
    
    // PlanarConfiguration (0028,0006) vr=US, vm=1, type=1C
    bool getPlanarConfiguration(unsigned long idx, MLuint16& parameter) const;
    bool getPlanarConfiguration(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getPlanarConfigurationTag() const { return "(0028,0006)"; }
    bool setPlanarConfiguration(unsigned long idx, MLuint16 parameter);
    
    // RedPaletteColorLookupTableDescriptor (0028,1101) vr=US_SS, vm=3, type=1C
    bool getRedPaletteColorLookupTableDescriptor(unsigned long idx, MLuint16& parameter) const;
    bool getRedPaletteColorLookupTableDescriptor(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getRedPaletteColorLookupTableDescriptorTag() const { return "(0028,1101)"; }
    bool setRedPaletteColorLookupTableDescriptor(unsigned long idx, MLuint16 parameter);
    
    // Rows (0028,0010) vr=US, vm=1, type=1
    bool getRows(unsigned long idx, MLuint16& parameter) const;
    bool getRows(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getRowsTag() const { return "(0028,0010)"; }
    bool setRows(unsigned long idx, MLuint16 parameter);
    
    // SamplesPerPixel (0028,0002) vr=US, vm=1, type=1
    bool getSamplesPerPixel(unsigned long idx, MLuint16& parameter) const;
    bool getSamplesPerPixel(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getSamplesPerPixelTag() const { return "(0028,0002)"; }
    bool setSamplesPerPixel(unsigned long idx, MLuint16 parameter);
    
    // SmallestImagePixelValue (0028,0106) vr=US_SS, vm=1, type=3
    bool getSmallestImagePixelValue(unsigned long idx, MLuint16& parameter) const;
    bool getSmallestImagePixelValue(DCMTree::TreePtr item, MLuint16& parameter) const;
    std::string getSmallestImagePixelValueTag() const { return "(0028,0106)"; }
    bool setSmallestImagePixelValue(unsigned long idx, MLuint16 parameter);
     
    
    void setSequence(std::vector<DcmDRTIconImageSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTIconImageSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTIconImageSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTIconImageSequenceInterface::Item();
    }
    
    DcmDRTIconImageSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTIconImageSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTIconImageSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }

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