ml::DcmDRTDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTDoseReferenceSequence. More...

#include <mlDcmDRTDoseReferenceSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTDoseReferenceSequenceInterface (DRTDoseReferenceSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTDoseReferenceSequenceInterface ()
 Default virtual Destructor.
bool getConstraintWeight (unsigned long idx, std::string &parameter)
bool getConstraintWeight (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getConstraintWeightTag () const
bool setConstraintWeight (unsigned long idx, std::string &parameter)
bool getDeliveryMaximumDose (unsigned long idx, std::string &parameter)
bool getDeliveryMaximumDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDeliveryMaximumDoseTag () const
bool setDeliveryMaximumDose (unsigned long idx, std::string &parameter)
bool getDeliveryWarningDose (unsigned long idx, std::string &parameter)
bool getDeliveryWarningDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDeliveryWarningDoseTag () const
bool setDeliveryWarningDose (unsigned long idx, std::string &parameter)
bool getDoseReferenceDescription (unsigned long idx, std::string &parameter)
bool getDoseReferenceDescription (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDoseReferenceDescriptionTag () const
bool setDoseReferenceDescription (unsigned long idx, std::string &parameter)
bool getDoseReferenceNumber (unsigned long idx, std::string &parameter)
bool getDoseReferenceNumber (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDoseReferenceNumberTag () const
bool setDoseReferenceNumber (unsigned long idx, std::string &parameter)
bool getDoseReferencePointCoordinates (unsigned long idx, std::string &parameter)
bool getDoseReferencePointCoordinates (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDoseReferencePointCoordinatesTag () const
bool setDoseReferencePointCoordinates (unsigned long idx, std::string &parameter)
bool getDoseReferenceStructureType (unsigned long idx, std::string &parameter)
bool getDoseReferenceStructureType (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDoseReferenceStructureTypeTag () const
bool setDoseReferenceStructureType (unsigned long idx, std::string &parameter)
bool getDoseReferenceType (unsigned long idx, std::string &parameter)
bool getDoseReferenceType (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDoseReferenceTypeTag () const
bool setDoseReferenceType (unsigned long idx, std::string &parameter)
bool getDoseReferenceUID (unsigned long idx, std::string &parameter)
bool getDoseReferenceUID (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDoseReferenceUIDTag () const
bool setDoseReferenceUID (unsigned long idx, std::string &parameter)
bool getNominalPriorDose (unsigned long idx, std::string &parameter)
bool getNominalPriorDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getNominalPriorDoseTag () const
bool setNominalPriorDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskFullVolumeDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskFullVolumeDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getOrganAtRiskFullVolumeDoseTag () const
bool setOrganAtRiskFullVolumeDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskLimitDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskLimitDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getOrganAtRiskLimitDoseTag () const
bool setOrganAtRiskLimitDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskMaximumDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskMaximumDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getOrganAtRiskMaximumDoseTag () const
bool setOrganAtRiskMaximumDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskOverdoseVolumeFraction (unsigned long idx, std::string &parameter)
bool getOrganAtRiskOverdoseVolumeFraction (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getOrganAtRiskOverdoseVolumeFractionTag () const
bool setOrganAtRiskOverdoseVolumeFraction (unsigned long idx, std::string &parameter)
bool getReferencedROINumber (unsigned long idx, std::string &parameter)
bool getReferencedROINumber (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getReferencedROINumberTag () const
bool setReferencedROINumber (unsigned long idx, std::string &parameter)
bool getTargetMaximumDose (unsigned long idx, std::string &parameter)
bool getTargetMaximumDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getTargetMaximumDoseTag () const
bool setTargetMaximumDose (unsigned long idx, std::string &parameter)
bool getTargetMinimumDose (unsigned long idx, std::string &parameter)
bool getTargetMinimumDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getTargetMinimumDoseTag () const
bool setTargetMinimumDose (unsigned long idx, std::string &parameter)
bool getTargetPrescriptionDose (unsigned long idx, std::string &parameter)
bool getTargetPrescriptionDose (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getTargetPrescriptionDoseTag () const
bool setTargetPrescriptionDose (unsigned long idx, std::string &parameter)
bool getTargetUnderdoseVolumeFraction (unsigned long idx, std::string &parameter)
bool getTargetUnderdoseVolumeFraction (DRTDoseReferenceSequence::Item &item, std::string &parameter)
std::string getTargetUnderdoseVolumeFractionTag () const
bool setTargetUnderdoseVolumeFraction (unsigned long idx, std::string &parameter)
void setSequence (DRTDoseReferenceSequence *dcmSequence)
 Set the DRTDoseReferenceSequence this interface class provides access to.
DRTDoseReferenceSequence * getSequence () const
 Return the DRTDoseReferenceSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTDoseReferenceSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTDoseReferenceSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTDoseReferenceSequence::Item * addItem ()
 Return number of items the internal sequence consists of.
bool insertItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
bool removeItem (const unsigned long idx)
 Return number of items the internal sequence consists of.

Protected Attributes

DRTDoseReferenceSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTDoseReferenceSequence.

Definition at line 42 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTDoseReferenceSequenceInterface::DcmDRTDoseReferenceSequenceInterface ( DRTDoseReferenceSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTDoseReferenceSequenceInterface.h.

virtual ml::DcmDRTDoseReferenceSequenceInterface::~DcmDRTDoseReferenceSequenceInterface (  )  [inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Member Function Documentation

DRTDoseReferenceSequence::Item* ml::DcmDRTDoseReferenceSequenceInterface::addItem (  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 203 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getConstraintWeight ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getConstraintWeight ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getConstraintWeightTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryMaximumDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryMaximumDoseTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryWarningDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryWarningDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryWarningDoseTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceDescription ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceDescription ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceDescriptionTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceNumber ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceNumberTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferencePointCoordinates ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferencePointCoordinates ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferencePointCoordinatesTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceStructureType ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceStructureType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceStructureTypeTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceType ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceTypeTag (  )  const [inline]

Definition at line 95 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceUID ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceUID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceUIDTag (  )  const [inline]

Definition at line 101 of file mlDcmDRTDoseReferenceSequenceInterface.h.

DRTDoseReferenceSequence::Item* ml::DcmDRTDoseReferenceSequenceInterface::getItem ( const unsigned long  idx  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 194 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getNominalPriorDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getNominalPriorDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getNominalPriorDoseTag (  )  const [inline]

Definition at line 107 of file mlDcmDRTDoseReferenceSequenceInterface.h.

MLint ml::DcmDRTDoseReferenceSequenceInterface::getNumberOfItems (  )  const [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 185 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskFullVolumeDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskFullVolumeDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskFullVolumeDoseTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskLimitDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskLimitDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskLimitDoseTag (  )  const [inline]

Definition at line 119 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskMaximumDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskMaximumDoseTag (  )  const [inline]

Definition at line 125 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskOverdoseVolumeFraction ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskOverdoseVolumeFraction ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskOverdoseVolumeFractionTag (  )  const [inline]

Definition at line 131 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getReferencedROINumber ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getReferencedROINumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getReferencedROINumberTag (  )  const [inline]

Definition at line 137 of file mlDcmDRTDoseReferenceSequenceInterface.h.

DRTDoseReferenceSequence* ml::DcmDRTDoseReferenceSequenceInterface::getSequence (  )  const [inline]

Return the DRTDoseReferenceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTDoseReferenceSequence

Definition at line 173 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMaximumDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetMaximumDoseTag (  )  const [inline]

Definition at line 143 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMinimumDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMinimumDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetMinimumDoseTag (  )  const [inline]

Definition at line 149 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetPrescriptionDose ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetPrescriptionDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetPrescriptionDoseTag (  )  const [inline]

Definition at line 155 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetUnderdoseVolumeFraction ( DRTDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetUnderdoseVolumeFraction ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetUnderdoseVolumeFractionTag (  )  const [inline]

Definition at line 161 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::hasSequence (  )  const [inline]

Check if the DRTDoseReferenceSequence is set.

Returns:
True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::insertItem ( const unsigned long  idx  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 214 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::removeItem ( const unsigned long  idx  )  [inline]

Return number of items the internal sequence consists of.

Returns:
Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 225 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::setConstraintWeight ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDeliveryMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDeliveryWarningDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceDescription ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferencePointCoordinates ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceStructureType ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceType ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceUID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setNominalPriorDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskFullVolumeDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskLimitDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskOverdoseVolumeFraction ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setReferencedROINumber ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTDoseReferenceSequenceInterface::setSequence ( DRTDoseReferenceSequence *  dcmSequence  )  [inline]

Set the DRTDoseReferenceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTDoseReferenceSequence

Definition at line 167 of file mlDcmDRTDoseReferenceSequenceInterface.h.

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetMinimumDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetPrescriptionDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetUnderdoseVolumeFraction ( unsigned long  idx,
std::string &  parameter 
)

Member Data Documentation

DRTDoseReferenceSequence* ml::DcmDRTDoseReferenceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 235 of file mlDcmDRTDoseReferenceSequenceInterface.h.

The documentation for this class was generated from the following file:
Generated on Sat Sep 3 18:39:45 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8