512 lines
21 KiB
C++
512 lines
21 KiB
C++
/*
|
|
*
|
|
* Copyright (C) 2008-2012, OFFIS e.V. and ICSMED AG, Oldenburg, Germany
|
|
* Copyright (C) 2013-2015, J. Riesmeier, Oldenburg, Germany
|
|
* All rights reserved. See COPYRIGHT file for details.
|
|
*
|
|
* Header file for class DRTDVHSequence
|
|
*
|
|
* Generated automatically from DICOM PS 3.3-2015c
|
|
* File created on 2015-12-07 16:29:33
|
|
*
|
|
*/
|
|
|
|
|
|
#ifndef DRTDVHS_H
|
|
#define DRTDVHS_H
|
|
|
|
#include "dcmtk/config/osconfig.h" // make sure OS specific configuration is included first
|
|
|
|
#include "dcmtk/ofstd/oflist.h" // for standard list class
|
|
#include "dcmtk/dcmrt/drttypes.h" // module-specific helper class
|
|
#include "dcmtk/dcmrt/seq/drtdvrrs.h" // for DVHReferencedROISequence
|
|
|
|
|
|
/** Interface class for DVHSequence (3004,0050)
|
|
*/
|
|
class DCMTK_DCMRT_EXPORT DRTDVHSequence
|
|
: protected DRTTypes
|
|
{
|
|
|
|
public:
|
|
|
|
/** Item class
|
|
*/
|
|
class DCMTK_DCMRT_EXPORT Item
|
|
: protected DRTTypes
|
|
{
|
|
|
|
public:
|
|
|
|
// --- constructors, destructor and operators ---
|
|
|
|
/** (default) constructor
|
|
* @param emptyDefaultItem flag used to mark the empty default item
|
|
*/
|
|
Item(const OFBool emptyDefaultItem = OFFalse);
|
|
|
|
/** copy constructor
|
|
* @param copy item object to be copied
|
|
*/
|
|
Item(const Item ©);
|
|
|
|
/** destructor
|
|
*/
|
|
virtual ~Item();
|
|
|
|
/** assigment operator
|
|
* @param copy item object to be copied
|
|
*/
|
|
Item &operator=(const Item ©);
|
|
|
|
// --- general methods ---
|
|
|
|
/** clear all internal member variables
|
|
*/
|
|
void clear();
|
|
|
|
/** check if item is empty
|
|
* @return OFTrue if item is empty, OFFalse otherwise
|
|
*/
|
|
OFBool isEmpty();
|
|
|
|
/** check if item is valid, i.e.\ not the empty default item
|
|
* @return OFTrue if item is valid, OFFalse otherwise
|
|
*/
|
|
OFBool isValid() const;
|
|
|
|
// --- input/output methods ---
|
|
|
|
/** read elements from sequence item
|
|
* @param item reference to DICOM sequence item from which the elements should be read
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition read(DcmItem &item);
|
|
|
|
/** write elements to sequence item
|
|
* @param item reference to DICOM sequence item to which the elements should be written
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition write(DcmItem &item);
|
|
|
|
// --- get DICOM attribute values ---
|
|
|
|
/** get DVHData (3004,0058)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHData(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DVHData (3004,0058)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHData(Float64 &value, const unsigned long pos = 0) const;
|
|
|
|
/** get DVHData (3004,0058)
|
|
* @param value reference to variable in which the value(s) should be stored
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHData(OFVector<Float64> &value) const;
|
|
|
|
/** get DVHDoseScaling (3004,0052)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHDoseScaling(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DVHDoseScaling (3004,0052)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHDoseScaling(Float64 &value, const unsigned long pos = 0) const;
|
|
|
|
/** get DVHMaximumDose (3004,0072)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHMaximumDose(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DVHMaximumDose (3004,0072)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHMaximumDose(Float64 &value, const unsigned long pos = 0) const;
|
|
|
|
/** get DVHMeanDose (3004,0074)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHMeanDose(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DVHMeanDose (3004,0074)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHMeanDose(Float64 &value, const unsigned long pos = 0) const;
|
|
|
|
/** get DVHMinimumDose (3004,0070)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHMinimumDose(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DVHMinimumDose (3004,0070)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHMinimumDose(Float64 &value, const unsigned long pos = 0) const;
|
|
|
|
/** get DVHNumberOfBins (3004,0056)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHNumberOfBins(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DVHNumberOfBins (3004,0056)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHNumberOfBins(Sint32 &value, const unsigned long pos = 0) const;
|
|
|
|
/** get DVHType (3004,0001)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHType(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DVHVolumeUnits (3004,0054)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDVHVolumeUnits(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DoseType (3004,0004)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDoseType(OFString &value, const signed long pos = 0) const;
|
|
|
|
/** get DoseUnits (3004,0002)
|
|
* @param value reference to variable in which the value should be stored
|
|
* @param pos index of the value to get (0..vm-1), -1 for all components
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getDoseUnits(OFString &value, const signed long pos = 0) const;
|
|
|
|
// --- get DICOM sequence attributes ---
|
|
|
|
/** get DVHReferencedROISequence (3004,0060)
|
|
* @return reference to sequence element
|
|
*/
|
|
DRTDVHReferencedROISequence &getDVHReferencedROISequence()
|
|
{ return DVHReferencedROISequence; }
|
|
|
|
/** get DVHReferencedROISequence (3004,0060)
|
|
* @return const reference to sequence element
|
|
*/
|
|
const DRTDVHReferencedROISequence &getDVHReferencedROISequence() const
|
|
{ return DVHReferencedROISequence; }
|
|
|
|
// --- set DICOM attribute values ---
|
|
|
|
/** set DVHData (3004,0058)
|
|
* @param value value to be set (possibly multi-valued) or "" for no value
|
|
* @param check check 'value' for conformance with VR (DS) and VM (2-2n) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHData(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DVHDoseScaling (3004,0052)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (DS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHDoseScaling(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DVHMaximumDose (3004,0072)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (DS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHMaximumDose(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DVHMeanDose (3004,0074)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (DS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHMeanDose(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DVHMinimumDose (3004,0070)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (DS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHMinimumDose(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DVHNumberOfBins (3004,0056)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (IS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHNumberOfBins(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DVHType (3004,0001)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (CS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHType(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DVHVolumeUnits (3004,0054)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (CS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDVHVolumeUnits(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DoseType (3004,0004)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (CS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDoseType(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
/** set DoseUnits (3004,0002)
|
|
* @param value value to be set (single value only) or "" for no value
|
|
* @param check check 'value' for conformance with VR (CS) and VM (1) if enabled
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition setDoseUnits(const OFString &value, const OFBool check = OFTrue);
|
|
|
|
private:
|
|
|
|
/// internal flag used to mark the empty default item
|
|
/*const*/ OFBool EmptyDefaultItem;
|
|
|
|
/// DVHData (3004,0058) vr=DS, vm=2-2n, type=1
|
|
DcmDecimalString DVHData;
|
|
/// DVHDoseScaling (3004,0052) vr=DS, vm=1, type=1
|
|
DcmDecimalString DVHDoseScaling;
|
|
/// DVHMaximumDose (3004,0072) vr=DS, vm=1, type=3
|
|
DcmDecimalString DVHMaximumDose;
|
|
/// DVHMeanDose (3004,0074) vr=DS, vm=1, type=3
|
|
DcmDecimalString DVHMeanDose;
|
|
/// DVHMinimumDose (3004,0070) vr=DS, vm=1, type=3
|
|
DcmDecimalString DVHMinimumDose;
|
|
/// DVHNumberOfBins (3004,0056) vr=IS, vm=1, type=1
|
|
DcmIntegerString DVHNumberOfBins;
|
|
/// DVHReferencedROISequence (3004,0060) vr=SQ, vm=1, type=1
|
|
DRTDVHReferencedROISequence DVHReferencedROISequence;
|
|
/// DVHType (3004,0001) vr=CS, vm=1, type=1
|
|
DcmCodeString DVHType;
|
|
/// DVHVolumeUnits (3004,0054) vr=CS, vm=1, type=1
|
|
DcmCodeString DVHVolumeUnits;
|
|
/// DoseType (3004,0004) vr=CS, vm=1, type=1
|
|
DcmCodeString DoseType;
|
|
/// DoseUnits (3004,0002) vr=CS, vm=1, type=1
|
|
DcmCodeString DoseUnits;
|
|
|
|
};
|
|
|
|
// --- constructors, destructor and operators ---
|
|
|
|
/** (default) constructor
|
|
* @param emptyDefaultSequence internal flag used to mark the empty default sequence
|
|
*/
|
|
DRTDVHSequence(const OFBool emptyDefaultSequence = OFFalse);
|
|
|
|
/** copy constructor
|
|
* @param copy sequence object to be copied
|
|
*/
|
|
DRTDVHSequence(const DRTDVHSequence ©);
|
|
|
|
/** destructor
|
|
*/
|
|
virtual ~DRTDVHSequence();
|
|
|
|
/** assigment operator
|
|
* @param copy sequence object to be copied
|
|
*/
|
|
DRTDVHSequence &operator=(const DRTDVHSequence ©);
|
|
|
|
// --- general methods ---
|
|
|
|
/** clear all internal member variables
|
|
*/
|
|
void clear();
|
|
|
|
/** check if sequence is empty
|
|
* @return OFTrue if sequence is empty, OFFalse otherwise
|
|
*/
|
|
OFBool isEmpty();
|
|
|
|
/** check if sequence is valid, i.e.\ not the empty default sequence
|
|
* @return OFTrue if sequence is valid, OFFalse otherwise
|
|
*/
|
|
OFBool isValid() const;
|
|
|
|
/** get number of items in the sequence
|
|
* @return number of items
|
|
*/
|
|
unsigned long getNumberOfItems() const;
|
|
|
|
/** goto first item in the sequence
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition gotoFirstItem();
|
|
|
|
/** goto next item in the sequence
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition gotoNextItem();
|
|
|
|
/** goto particular item in the sequence
|
|
* @param num number of the item to be selected (0..num-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition gotoItem(const unsigned long num);
|
|
|
|
/** get current item in the sequence
|
|
* @param item reference to item pointer (result variable)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getCurrentItem(Item *&item) const;
|
|
|
|
/** get current item in the sequence
|
|
* @return reference to specified item if successful, empty default item otherwise
|
|
*/
|
|
Item &getCurrentItem();
|
|
|
|
/** get current item in the sequence
|
|
* @return const reference to specified item if successful, empty default item otherwise
|
|
*/
|
|
const Item &getCurrentItem() const;
|
|
|
|
/** get particular item in the sequence
|
|
* @param num number of the item to be retrieved (0..num-1)
|
|
* @param item reference to item pointer (result variable)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition getItem(const unsigned long num, Item *&item);
|
|
|
|
/** get particular item in the sequence
|
|
* @param num number of the item to be retrieved (0..num-1)
|
|
* @return reference to specified item if successful, empty default item otherwise
|
|
*/
|
|
Item &getItem(const unsigned long num);
|
|
|
|
/** get particular item in the sequence
|
|
* @param num number of the item to be retrieved (0..num-1)
|
|
* @return const reference to specified item if successful, empty default item otherwise
|
|
*/
|
|
const Item &getItem(const unsigned long num) const;
|
|
|
|
/** get particular item in the sequence
|
|
* @param num number of the item to be retrieved (0..num-1)
|
|
* @return reference to specified item if successful, empty default item otherwise
|
|
*/
|
|
Item &operator[](const unsigned long num);
|
|
|
|
/** get particular item in the sequence
|
|
* @param num number of the item to be retrieved (0..num-1)
|
|
* @return const reference to specified item if successful, empty default item otherwise
|
|
*/
|
|
const Item &operator[](const unsigned long num) const;
|
|
|
|
/** add new item to the end of this sequence
|
|
* @param item reference to new item pointer (result variable)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition addItem(Item *&item);
|
|
|
|
/** insert new item into the sequence
|
|
* @param pos position where the new item is to be inserted (0..num)
|
|
* @param item reference to new item pointer (result variable)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition insertItem(const unsigned long pos, Item *&item);
|
|
|
|
/** remove particular item from the sequence
|
|
* @param pos position of the item to be removed (0..num-1)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition removeItem(const unsigned long pos);
|
|
|
|
// --- input/output methods ---
|
|
|
|
/** read sequence of items from dataset
|
|
* @param dataset reference to DICOM dataset from which the sequence should be read
|
|
* @param card cardinality (valid range for number of items)
|
|
* @param type value type (valid value: "1", "1C", "2" or something else which is not checked)
|
|
* @param moduleName optional module/sequence name to be printed (default: "RT object" if NULL)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition read(DcmItem &dataset,
|
|
const OFString &card,
|
|
const OFString &type,
|
|
const char *moduleName = NULL);
|
|
|
|
/** write sequence of items to dataset
|
|
* @param dataset reference to DICOM dataset to which the sequence should be written
|
|
* @param card cardinality (valid range for number of items)
|
|
* @param type value type (valid value: "1", "2" or something else which is not checked)
|
|
* @param moduleName optional module/sequence name to be printed (default: "RT object" if NULL)
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition write(DcmItem &dataset,
|
|
const OFString &card,
|
|
const OFString &type,
|
|
const char *moduleName = NULL);
|
|
|
|
protected:
|
|
|
|
/** goto particular item in the sequence
|
|
* @param num number of the item to be selected (0..num-1)
|
|
* @param iterator list iterator storing the position of the item
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition gotoItem(const unsigned long num,
|
|
OFListIterator(Item *) &iterator);
|
|
|
|
/** goto particular item in the sequence
|
|
* @param num number of the item to be selected (0..num-1)
|
|
* @param iterator list iterator storing the position of the item
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
|
*/
|
|
OFCondition gotoItem(const unsigned long num,
|
|
OFListConstIterator(Item *) &iterator) const;
|
|
|
|
private:
|
|
|
|
/// internal flag used to mark the empty default sequence
|
|
/*const*/ OFBool EmptyDefaultSequence;
|
|
|
|
/// list of items in this sequence
|
|
OFList<Item *> SequenceOfItems;
|
|
/// currently selected item
|
|
OFListIterator(Item *) CurrentItem;
|
|
/// empty default item
|
|
Item EmptyItem;
|
|
|
|
};
|
|
|
|
|
|
#endif
|