371 lines
14 KiB
C
371 lines
14 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 DRTIonBeamLimitingDeviceSequence
|
||
|
|
*
|
||
|
|
* Generated automatically from DICOM PS 3.3-2015c
|
||
|
|
* File created on 2015-12-07 16:29:33
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef DRTIBLDS_H
|
||
|
|
#define DRTIBLDS_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
|
||
|
|
|
||
|
|
|
||
|
|
/** Interface class for IonBeamLimitingDeviceSequence (300a,03a4)
|
||
|
|
*/
|
||
|
|
class DCMTK_DCMRT_EXPORT DRTIonBeamLimitingDeviceSequence
|
||
|
|
: 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 IsocenterToBeamLimitingDeviceDistance (300a,00bb)
|
||
|
|
* @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 getIsocenterToBeamLimitingDeviceDistance(Float32 &value, const unsigned long pos = 0) const;
|
||
|
|
|
||
|
|
/** get LeafPositionBoundaries (300a,00be)
|
||
|
|
* @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 getLeafPositionBoundaries(OFString &value, const signed long pos = 0) const;
|
||
|
|
|
||
|
|
/** get LeafPositionBoundaries (300a,00be)
|
||
|
|
* @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 getLeafPositionBoundaries(Float64 &value, const unsigned long pos = 0) const;
|
||
|
|
|
||
|
|
/** get LeafPositionBoundaries (300a,00be)
|
||
|
|
* @param value reference to variable in which the value(s) should be stored
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
OFCondition getLeafPositionBoundaries(OFVector<Float64> &value) const;
|
||
|
|
|
||
|
|
/** get NumberOfLeafJawPairs (300a,00bc)
|
||
|
|
* @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 getNumberOfLeafJawPairs(OFString &value, const signed long pos = 0) const;
|
||
|
|
|
||
|
|
/** get NumberOfLeafJawPairs (300a,00bc)
|
||
|
|
* @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 getNumberOfLeafJawPairs(Sint32 &value, const unsigned long pos = 0) const;
|
||
|
|
|
||
|
|
/** get RTBeamLimitingDeviceType (300a,00b8)
|
||
|
|
* @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 getRTBeamLimitingDeviceType(OFString &value, const signed long pos = 0) const;
|
||
|
|
|
||
|
|
// --- set DICOM attribute values ---
|
||
|
|
|
||
|
|
/** set IsocenterToBeamLimitingDeviceDistance (300a,00bb)
|
||
|
|
* @param value value to be set (should be valid for this VR)
|
||
|
|
* @param pos index of the value to be set (0..vm-1), vm=1
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
OFCondition setIsocenterToBeamLimitingDeviceDistance(const Float32 value, const unsigned long pos = 0);
|
||
|
|
|
||
|
|
/** set LeafPositionBoundaries (300a,00be)
|
||
|
|
* @param value value to be set (possibly multi-valued) or "" for no value
|
||
|
|
* @param check check 'value' for conformance with VR (DS) and VM (3-n) if enabled
|
||
|
|
* @return status, EC_Normal if successful, an error code otherwise
|
||
|
|
*/
|
||
|
|
OFCondition setLeafPositionBoundaries(const OFString &value, const OFBool check = OFTrue);
|
||
|
|
|
||
|
|
/** set NumberOfLeafJawPairs (300a,00bc)
|
||
|
|
* @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 setNumberOfLeafJawPairs(const OFString &value, const OFBool check = OFTrue);
|
||
|
|
|
||
|
|
/** set RTBeamLimitingDeviceType (300a,00b8)
|
||
|
|
* @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 setRTBeamLimitingDeviceType(const OFString &value, const OFBool check = OFTrue);
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
/// internal flag used to mark the empty default item
|
||
|
|
/*const*/ OFBool EmptyDefaultItem;
|
||
|
|
|
||
|
|
/// IsocenterToBeamLimitingDeviceDistance (300a,00bb) vr=FL, vm=1, type=2
|
||
|
|
DcmFloatingPointSingle IsocenterToBeamLimitingDeviceDistance;
|
||
|
|
/// LeafPositionBoundaries (300a,00be) vr=DS, vm=3-n, type=1C
|
||
|
|
DcmDecimalString LeafPositionBoundaries;
|
||
|
|
/// NumberOfLeafJawPairs (300a,00bc) vr=IS, vm=1, type=1
|
||
|
|
DcmIntegerString NumberOfLeafJawPairs;
|
||
|
|
/// RTBeamLimitingDeviceType (300a,00b8) vr=CS, vm=1, type=1
|
||
|
|
DcmCodeString RTBeamLimitingDeviceType;
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
// --- constructors, destructor and operators ---
|
||
|
|
|
||
|
|
/** (default) constructor
|
||
|
|
* @param emptyDefaultSequence internal flag used to mark the empty default sequence
|
||
|
|
*/
|
||
|
|
DRTIonBeamLimitingDeviceSequence(const OFBool emptyDefaultSequence = OFFalse);
|
||
|
|
|
||
|
|
/** copy constructor
|
||
|
|
* @param copy sequence object to be copied
|
||
|
|
*/
|
||
|
|
DRTIonBeamLimitingDeviceSequence(const DRTIonBeamLimitingDeviceSequence ©);
|
||
|
|
|
||
|
|
/** destructor
|
||
|
|
*/
|
||
|
|
virtual ~DRTIonBeamLimitingDeviceSequence();
|
||
|
|
|
||
|
|
/** assigment operator
|
||
|
|
* @param copy sequence object to be copied
|
||
|
|
*/
|
||
|
|
DRTIonBeamLimitingDeviceSequence &operator=(const DRTIonBeamLimitingDeviceSequence ©);
|
||
|
|
|
||
|
|
// --- 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
|