ml::DcmDRTReferencedDoseReferenceSequenceInterface Class Reference

Class to provide access to DRTReferencedDoseReferenceSequence. More...

#include <mlDcmDRTReferencedDoseReferenceSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTReferencedDoseReferenceSequenceInterface (DRTReferencedDoseReferenceSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTReferencedDoseReferenceSequenceInterface ()
 Default virtual Destructor.
bool getConstraintWeight (unsigned long idx, std::string &parameter)
bool getConstraintWeight (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::Item &item, std::string &parameter)
std::string getDeliveryWarningDoseTag () const
bool setDeliveryWarningDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskFullVolumeDose (unsigned long idx, std::string &parameter)
bool getOrganAtRiskFullVolumeDose (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::Item &item, std::string &parameter)
std::string getOrganAtRiskOverdoseVolumeFractionTag () const
bool setOrganAtRiskOverdoseVolumeFraction (unsigned long idx, std::string &parameter)
bool getReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)
bool getReferencedDoseReferenceNumber (DRTReferencedDoseReferenceSequence::Item &item, std::string &parameter)
std::string getReferencedDoseReferenceNumberTag () const
bool setReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)
bool getTargetMaximumDose (unsigned long idx, std::string &parameter)
bool getTargetMaximumDose (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::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 (DRTReferencedDoseReferenceSequence::Item &item, std::string &parameter)
std::string getTargetUnderdoseVolumeFractionTag () const
bool setTargetUnderdoseVolumeFraction (unsigned long idx, std::string &parameter)
void setSequence (DRTReferencedDoseReferenceSequence *dcmSequence)
 Set the DRTReferencedDoseReferenceSequence this interface class provides access to.
DRTReferencedDoseReferenceSequence * getSequence () const
 Return the DRTReferencedDoseReferenceSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTReferencedDoseReferenceSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTReferencedDoseReferenceSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTReferencedDoseReferenceSequence::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

DRTReferencedDoseReferenceSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTReferencedDoseReferenceSequence.

Definition at line 42 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTReferencedDoseReferenceSequenceInterface::DcmDRTReferencedDoseReferenceSequenceInterface ( DRTReferencedDoseReferenceSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

Member Function Documentation

DRTReferencedDoseReferenceSequence::Item* ml::DcmDRTReferencedDoseReferenceSequenceInterface::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 161 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getConstraintWeight ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getDeliveryMaximumDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 59 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getDeliveryWarningDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 65 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

DRTReferencedDoseReferenceSequence::Item* ml::DcmDRTReferencedDoseReferenceSequenceInterface::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 152 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

MLint ml::DcmDRTReferencedDoseReferenceSequenceInterface::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 143 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getOrganAtRiskFullVolumeDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 71 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getOrganAtRiskLimitDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 77 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getOrganAtRiskMaximumDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 83 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getOrganAtRiskOverdoseVolumeFraction ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 89 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumber ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedDoseReferenceSequenceInterface::getReferencedDoseReferenceNumberTag (  )  const [inline]

Definition at line 95 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

DRTReferencedDoseReferenceSequence* ml::DcmDRTReferencedDoseReferenceSequenceInterface::getSequence (  )  const [inline]

Return the DRTReferencedDoseReferenceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedDoseReferenceSequence

Definition at line 131 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getTargetMaximumDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 101 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getTargetMinimumDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 107 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getTargetPrescriptionDose ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 113 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::getTargetUnderdoseVolumeFraction ( DRTReferencedDoseReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 119 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

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

Check if the DRTReferencedDoseReferenceSequence is set.

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

Definition at line 137 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::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 172 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::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 183 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

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

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

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

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

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

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

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

bool ml::DcmDRTReferencedDoseReferenceSequenceInterface::setReferencedDoseReferenceNumber ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTReferencedDoseReferenceSequenceInterface::setSequence ( DRTReferencedDoseReferenceSequence *  dcmSequence  )  [inline]

Set the DRTReferencedDoseReferenceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedDoseReferenceSequence

Definition at line 125 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

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

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

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

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

Member Data Documentation

DRTReferencedDoseReferenceSequence* ml::DcmDRTReferencedDoseReferenceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 193 of file mlDcmDRTReferencedDoseReferenceSequenceInterface.h.

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