mlDcmDRTFixationDeviceSequenceInterface.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 __mlDcmDRTFixationDeviceSequenceInterface_H
#define __mlDcmDRTFixationDeviceSequenceInterface_H
 
// Local includes
#include "mlDcmtkAccessories.h"
 
// Dcmtk includes
//#include "mlDcmDRTFixationDeviceSequenceInterface.h" //DRTFixationDeviceSequence
 
 
// ML includes
#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
 
ML_START_NAMESPACE
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
class MLDCMTKACCESSORIES_EXPORT DcmDRTFixationDeviceSequenceInterface
{
  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; }
 
      
    // AccessoryCode (300a,00f9) vr=LO, vm=1, type=3
    bool getAccessoryCode(std::string& parameter) const;
    std::string getAccessoryCodeTag() const { return "(300a,00f9)"; }
    bool setAccessoryCode(std::string parameter);
    
    // FixationDeviceDescription (300a,0196) vr=ST, vm=1, type=3
    bool getFixationDeviceDescription(std::string& parameter) const;
    std::string getFixationDeviceDescriptionTag() const { return "(300a,0196)"; }
    bool setFixationDeviceDescription(std::string parameter);
    
    // FixationDeviceLabel (300a,0194) vr=SH, vm=1, type=2C
    bool getFixationDeviceLabel(std::string& parameter) const;
    std::string getFixationDeviceLabelTag() const { return "(300a,0194)"; }
    bool setFixationDeviceLabel(std::string parameter);
    
    // FixationDevicePitchAngle (300a,0199) vr=FL, vm=1, type=3
    bool getFixationDevicePitchAngle(float& parameter) const;
    std::string getFixationDevicePitchAngleTag() const { return "(300a,0199)"; }
    bool setFixationDevicePitchAngle(float parameter);
    
    // FixationDevicePosition (300a,0198) vr=SH, vm=1, type=3
    bool getFixationDevicePosition(std::string& parameter) const;
    std::string getFixationDevicePositionTag() const { return "(300a,0198)"; }
    bool setFixationDevicePosition(std::string parameter);
    
    // FixationDeviceRollAngle (300a,019a) vr=FL, vm=1, type=3
    bool getFixationDeviceRollAngle(float& parameter) const;
    std::string getFixationDeviceRollAngleTag() const { return "(300a,019a)"; }
    bool setFixationDeviceRollAngle(float parameter);
    
    // FixationDeviceType (300a,0192) vr=CS, vm=1, type=1C
    bool getFixationDeviceType(std::string& parameter) const;
    std::string getFixationDeviceTypeTag() const { return "(300a,0192)"; }
    bool setFixationDeviceType(std::string parameter);
    
 
    private:
 
      DCMTree::TreePtr _dcmItem;
      
    };
 
    DcmDRTFixationDeviceSequenceInterface()  { }
    
    DcmDRTFixationDeviceSequenceInterface(std::vector<DcmDRTFixationDeviceSequenceInterface::Item> dcmSequence) : _itemVec(dcmSequence) {}
 
    DcmDRTFixationDeviceSequenceInterface(DCMTree::TreePtrVector treePtrSeq) {
      for(size_t i=0; i < treePtrSeq.size(); i++)
      {
         _itemVec.push_back(DcmDRTFixationDeviceSequenceInterface::Item(treePtrSeq[i]));
      }
    }
    
    virtual ~DcmDRTFixationDeviceSequenceInterface() {} 
    // AccessoryCode (300a,00f9) vr=LO, vm=1, type=3
    bool getAccessoryCode(unsigned long idx, std::string& parameter) const;
    bool getAccessoryCode(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getAccessoryCodeTag() const { return "(300a,00f9)"; }
    bool setAccessoryCode(unsigned long idx, std::string parameter);
    
    // FixationDeviceDescription (300a,0196) vr=ST, vm=1, type=3
    bool getFixationDeviceDescription(unsigned long idx, std::string& parameter) const;
    bool getFixationDeviceDescription(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFixationDeviceDescriptionTag() const { return "(300a,0196)"; }
    bool setFixationDeviceDescription(unsigned long idx, std::string parameter);
    
    // FixationDeviceLabel (300a,0194) vr=SH, vm=1, type=2C
    bool getFixationDeviceLabel(unsigned long idx, std::string& parameter) const;
    bool getFixationDeviceLabel(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFixationDeviceLabelTag() const { return "(300a,0194)"; }
    bool setFixationDeviceLabel(unsigned long idx, std::string parameter);
    
    // FixationDevicePitchAngle (300a,0199) vr=FL, vm=1, type=3
    bool getFixationDevicePitchAngle(unsigned long idx, float& parameter) const;
    bool getFixationDevicePitchAngle(DCMTree::TreePtr item, float& parameter) const;
    std::string getFixationDevicePitchAngleTag() const { return "(300a,0199)"; }
    bool setFixationDevicePitchAngle(unsigned long idx, float parameter);
    
    // FixationDevicePosition (300a,0198) vr=SH, vm=1, type=3
    bool getFixationDevicePosition(unsigned long idx, std::string& parameter) const;
    bool getFixationDevicePosition(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFixationDevicePositionTag() const { return "(300a,0198)"; }
    bool setFixationDevicePosition(unsigned long idx, std::string parameter);
    
    // FixationDeviceRollAngle (300a,019a) vr=FL, vm=1, type=3
    bool getFixationDeviceRollAngle(unsigned long idx, float& parameter) const;
    bool getFixationDeviceRollAngle(DCMTree::TreePtr item, float& parameter) const;
    std::string getFixationDeviceRollAngleTag() const { return "(300a,019a)"; }
    bool setFixationDeviceRollAngle(unsigned long idx, float parameter);
    
    // FixationDeviceType (300a,0192) vr=CS, vm=1, type=1C
    bool getFixationDeviceType(unsigned long idx, std::string& parameter) const;
    bool getFixationDeviceType(DCMTree::TreePtr item, std::string& parameter) const;
    std::string getFixationDeviceTypeTag() const { return "(300a,0192)"; }
    bool setFixationDeviceType(unsigned long idx, std::string parameter);
     
    
    void setSequence(std::vector<DcmDRTFixationDeviceSequenceInterface::Item> dcmSequence) {
       _itemVec = dcmSequence;
    } 
       
    std::vector<DcmDRTFixationDeviceSequenceInterface::Item> getSequence() const {
      return _itemVec;
    }
    
    bool hasSequence() const {
      return (_itemVec.size() != 0);
    }
    
    MLint getNumberOfItems() const {
      return static_cast<MLint>(_itemVec.size());
    }
    
    DcmDRTFixationDeviceSequenceInterface::Item getItem(const size_t idx) const {
      if (_itemVec.size() > idx) {
        return _itemVec[idx];
      }
      return DcmDRTFixationDeviceSequenceInterface::Item();
    }
    
    DcmDRTFixationDeviceSequenceInterface::Item& addItem() {
      _itemVec.push_back(DcmDRTFixationDeviceSequenceInterface::Item());
      return _itemVec[_itemVec.size()-1];
    }
    
     void addItem(DcmDRTFixationDeviceSequenceInterface::Item newItem) {
      _itemVec.push_back(newItem);
     }
 
    bool insertItem(const size_t idx) {
      if (_itemVec.size() > idx) {
        std::vector<DcmDRTFixationDeviceSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.insert(it, DcmDRTFixationDeviceSequenceInterface::Item());
        return true;
      }
      return false;
    }
    
    bool removeItem(const size_t idx) {
      if ( _itemVec.size() > idx ) {
        std::vector<DcmDRTFixationDeviceSequenceInterface::Item>::iterator it =  _itemVec.begin();
        std::advance(it, idx);
        _itemVec.erase(it);
        return true;
      }
      return false;
    }
    
  protected:
    std::vector<DcmDRTFixationDeviceSequenceInterface::Item> _itemVec;
};
 
ML_END_NAMESPACE
 
#endif // __mlDcmDRTFixationDeviceSequenceInterface_H
 
/* MeVis-Hidden-Components-Start */
/* MeVis-Hidden-Components-End */