ml::DcmDRTDVHSequenceInterface Class Reference

Class to provide access to DRTDVHSequence. More...

#include <mlDcmDRTDVHSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTDVHSequenceInterface (DRTDVHSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTDVHSequenceInterface ()
 Default virtual Destructor.
bool getDVHData (unsigned long idx, std::string &parameter)
bool getDVHData (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHDataTag () const
bool setDVHData (unsigned long idx, std::string &parameter)
bool getDVHDoseScaling (unsigned long idx, std::string &parameter)
bool getDVHDoseScaling (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHDoseScalingTag () const
bool setDVHDoseScaling (unsigned long idx, std::string &parameter)
bool getDVHMaximumDose (unsigned long idx, std::string &parameter)
bool getDVHMaximumDose (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHMaximumDoseTag () const
bool setDVHMaximumDose (unsigned long idx, std::string &parameter)
bool getDVHMeanDose (unsigned long idx, std::string &parameter)
bool getDVHMeanDose (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHMeanDoseTag () const
bool setDVHMeanDose (unsigned long idx, std::string &parameter)
bool getDVHMinimumDose (unsigned long idx, std::string &parameter)
bool getDVHMinimumDose (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHMinimumDoseTag () const
bool setDVHMinimumDose (unsigned long idx, std::string &parameter)
bool getDVHNumberOfBins (unsigned long idx, std::string &parameter)
bool getDVHNumberOfBins (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHNumberOfBinsTag () const
bool setDVHNumberOfBins (unsigned long idx, std::string &parameter)
bool getDVHType (unsigned long idx, std::string &parameter)
bool getDVHType (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHTypeTag () const
bool setDVHType (unsigned long idx, std::string &parameter)
bool getDVHVolumeUnits (unsigned long idx, std::string &parameter)
bool getDVHVolumeUnits (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDVHVolumeUnitsTag () const
bool setDVHVolumeUnits (unsigned long idx, std::string &parameter)
bool getDoseType (unsigned long idx, std::string &parameter)
bool getDoseType (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDoseTypeTag () const
bool setDoseType (unsigned long idx, std::string &parameter)
bool getDoseUnits (unsigned long idx, std::string &parameter)
bool getDoseUnits (DRTDVHSequence::Item &item, std::string &parameter)
std::string getDoseUnitsTag () const
bool setDoseUnits (unsigned long idx, std::string &parameter)
DRTDVHReferencedROISequence & getDVHReferencedROISequence (unsigned long idx)
std::string getDVHReferencedROISequenceTag () const
void setSequence (DRTDVHSequence *dcmSequence)
 Set the DRTDVHSequence this interface class provides access to.
DRTDVHSequence * getSequence () const
 Return the DRTDVHSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTDVHSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTDVHSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTDVHSequence::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

DRTDVHSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTDVHSequence.

Definition at line 43 of file mlDcmDRTDVHSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTDVHSequenceInterface::DcmDRTDVHSequenceInterface ( DRTDVHSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTDVHSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTDVHSequenceInterface.h.

Member Function Documentation

DRTDVHSequence::Item* ml::DcmDRTDVHSequenceInterface::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 154 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDoseType ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDoseType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDoseTypeTag (  )  const [inline]

Definition at line 102 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDoseUnits ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDoseUnits ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDoseUnitsTag (  )  const [inline]

Definition at line 108 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHData ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHData ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHDataTag (  )  const [inline]

Definition at line 54 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHDoseScaling ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHDoseScaling ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHDoseScalingTag (  )  const [inline]

Definition at line 60 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHMaximumDose ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHMaximumDoseTag (  )  const [inline]

Definition at line 66 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHMeanDose ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHMeanDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHMeanDoseTag (  )  const [inline]

Definition at line 72 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHMinimumDose ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHMinimumDose ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHMinimumDoseTag (  )  const [inline]

Definition at line 78 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHNumberOfBins ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHNumberOfBins ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHNumberOfBinsTag (  )  const [inline]

Definition at line 84 of file mlDcmDRTDVHSequenceInterface.h.

DRTDVHReferencedROISequence& ml::DcmDRTDVHSequenceInterface::getDVHReferencedROISequence ( unsigned long  idx  ) 

std::string ml::DcmDRTDVHSequenceInterface::getDVHReferencedROISequenceTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHType ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHTypeTag (  )  const [inline]

Definition at line 90 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::getDVHVolumeUnits ( DRTDVHSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::getDVHVolumeUnits ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTDVHSequenceInterface::getDVHVolumeUnitsTag (  )  const [inline]

Definition at line 96 of file mlDcmDRTDVHSequenceInterface.h.

DRTDVHSequence::Item* ml::DcmDRTDVHSequenceInterface::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 145 of file mlDcmDRTDVHSequenceInterface.h.

MLint ml::DcmDRTDVHSequenceInterface::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 136 of file mlDcmDRTDVHSequenceInterface.h.

DRTDVHSequence* ml::DcmDRTDVHSequenceInterface::getSequence (  )  const [inline]

Return the DRTDVHSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTDVHSequence

Definition at line 124 of file mlDcmDRTDVHSequenceInterface.h.

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

Check if the DRTDVHSequence is set.

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

Definition at line 130 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::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 165 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::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 176 of file mlDcmDRTDVHSequenceInterface.h.

bool ml::DcmDRTDVHSequenceInterface::setDoseType ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDoseUnits ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHData ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHDoseScaling ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHMaximumDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHMeanDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHMinimumDose ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHNumberOfBins ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHType ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTDVHSequenceInterface::setDVHVolumeUnits ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTDVHSequenceInterface::setSequence ( DRTDVHSequence *  dcmSequence  )  [inline]

Set the DRTDVHSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTDVHSequence

Definition at line 118 of file mlDcmDRTDVHSequenceInterface.h.

Member Data Documentation

DRTDVHSequence* ml::DcmDRTDVHSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 186 of file mlDcmDRTDVHSequenceInterface.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