ml::DcmDRTIonRangeCompensatorSequenceInterface Class Reference

Class to provide access to DRTIonRangeCompensatorSequence. More...

#include <mlDcmDRTIonRangeCompensatorSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTIonRangeCompensatorSequenceInterface (DRTIonRangeCompensatorSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTIonRangeCompensatorSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter)
bool getAccessoryCode (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string &parameter)
bool getCompensatorColumnOffset (unsigned long idx, float &parameter)
bool getCompensatorColumnOffset (DRTIonRangeCompensatorSequence::Item &item, float &parameter)
std::string getCompensatorColumnOffsetTag () const
bool setCompensatorColumnOffset (unsigned long idx, float &parameter)
bool getCompensatorColumns (unsigned long idx, std::string &parameter)
bool getCompensatorColumns (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorColumnsTag () const
bool setCompensatorColumns (unsigned long idx, std::string &parameter)
bool getCompensatorDivergence (unsigned long idx, std::string &parameter)
bool getCompensatorDivergence (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorDivergenceTag () const
bool setCompensatorDivergence (unsigned long idx, std::string &parameter)
bool getCompensatorID (unsigned long idx, std::string &parameter)
bool getCompensatorID (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorIDTag () const
bool setCompensatorID (unsigned long idx, std::string &parameter)
bool getCompensatorMillingToolDiameter (unsigned long idx, float &parameter)
bool getCompensatorMillingToolDiameter (DRTIonRangeCompensatorSequence::Item &item, float &parameter)
std::string getCompensatorMillingToolDiameterTag () const
bool setCompensatorMillingToolDiameter (unsigned long idx, float &parameter)
bool getCompensatorMountingPosition (unsigned long idx, std::string &parameter)
bool getCompensatorMountingPosition (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorMountingPositionTag () const
bool setCompensatorMountingPosition (unsigned long idx, std::string &parameter)
bool getCompensatorNumber (unsigned long idx, std::string &parameter)
bool getCompensatorNumber (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorNumberTag () const
bool setCompensatorNumber (unsigned long idx, std::string &parameter)
bool getCompensatorPixelSpacing (unsigned long idx, std::string &parameter)
bool getCompensatorPixelSpacing (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorPixelSpacingTag () const
bool setCompensatorPixelSpacing (unsigned long idx, std::string &parameter)
bool getCompensatorPosition (unsigned long idx, std::string &parameter)
bool getCompensatorPosition (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorPositionTag () const
bool setCompensatorPosition (unsigned long idx, std::string &parameter)
bool getCompensatorRelativeStoppingPowerRatio (unsigned long idx, float &parameter)
bool getCompensatorRelativeStoppingPowerRatio (DRTIonRangeCompensatorSequence::Item &item, float &parameter)
std::string getCompensatorRelativeStoppingPowerRatioTag () const
bool setCompensatorRelativeStoppingPowerRatio (unsigned long idx, float &parameter)
bool getCompensatorRows (unsigned long idx, std::string &parameter)
bool getCompensatorRows (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorRowsTag () const
bool setCompensatorRows (unsigned long idx, std::string &parameter)
bool getCompensatorThicknessData (unsigned long idx, std::string &parameter)
bool getCompensatorThicknessData (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorThicknessDataTag () const
bool setCompensatorThicknessData (unsigned long idx, std::string &parameter)
bool getIsocenterToCompensatorDistances (unsigned long idx, float &parameter)
bool getIsocenterToCompensatorDistances (DRTIonRangeCompensatorSequence::Item &item, float &parameter)
std::string getIsocenterToCompensatorDistancesTag () const
bool setIsocenterToCompensatorDistances (unsigned long idx, float &parameter)
bool getIsocenterToCompensatorTrayDistance (unsigned long idx, float &parameter)
bool getIsocenterToCompensatorTrayDistance (DRTIonRangeCompensatorSequence::Item &item, float &parameter)
std::string getIsocenterToCompensatorTrayDistanceTag () const
bool setIsocenterToCompensatorTrayDistance (unsigned long idx, float &parameter)
bool getMaterialID (unsigned long idx, std::string &parameter)
bool getMaterialID (DRTIonRangeCompensatorSequence::Item &item, std::string &parameter)
std::string getMaterialIDTag () const
bool setMaterialID (unsigned long idx, std::string &parameter)
void setSequence (DRTIonRangeCompensatorSequence *dcmSequence)
 Set the DRTIonRangeCompensatorSequence this interface class provides access to.
DRTIonRangeCompensatorSequence * getSequence () const
 Return the DRTIonRangeCompensatorSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTIonRangeCompensatorSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTIonRangeCompensatorSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTIonRangeCompensatorSequence::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

DRTIonRangeCompensatorSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTIonRangeCompensatorSequence.

Definition at line 42 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTIonRangeCompensatorSequenceInterface::DcmDRTIonRangeCompensatorSequenceInterface ( DRTIonRangeCompensatorSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

Member Function Documentation

DRTIonRangeCompensatorSequence::Item* ml::DcmDRTIonRangeCompensatorSequenceInterface::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 185 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getAccessoryCode ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getAccessoryCode ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getAccessoryCodeTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnOffset ( DRTIonRangeCompensatorSequence::Item &  item,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnOffset ( unsigned long  idx,
float &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnOffsetTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumns ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumns ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnsTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorDivergence ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorDivergence ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorDivergenceTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorID ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorIDTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMillingToolDiameter ( DRTIonRangeCompensatorSequence::Item &  item,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMillingToolDiameter ( unsigned long  idx,
float &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMillingToolDiameterTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMountingPosition ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMountingPosition ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMountingPositionTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorNumber ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorNumberTag (  )  const [inline]

Definition at line 95 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPixelSpacing ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPixelSpacing ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPixelSpacingTag (  )  const [inline]

Definition at line 101 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPosition ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPosition ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPositionTag (  )  const [inline]

Definition at line 107 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRelativeStoppingPowerRatio ( DRTIonRangeCompensatorSequence::Item &  item,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRelativeStoppingPowerRatio ( unsigned long  idx,
float &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRelativeStoppingPowerRatioTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRows ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRows ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRowsTag (  )  const [inline]

Definition at line 119 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorThicknessData ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorThicknessData ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorThicknessDataTag (  )  const [inline]

Definition at line 125 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorDistances ( DRTIonRangeCompensatorSequence::Item &  item,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorDistances ( unsigned long  idx,
float &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorDistancesTag (  )  const [inline]

Definition at line 131 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorTrayDistance ( DRTIonRangeCompensatorSequence::Item &  item,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorTrayDistance ( unsigned long  idx,
float &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorTrayDistanceTag (  )  const [inline]

Definition at line 137 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

DRTIonRangeCompensatorSequence::Item* ml::DcmDRTIonRangeCompensatorSequenceInterface::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 176 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getMaterialID ( DRTIonRangeCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getMaterialID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getMaterialIDTag (  )  const [inline]

Definition at line 143 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

MLint ml::DcmDRTIonRangeCompensatorSequenceInterface::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 167 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

DRTIonRangeCompensatorSequence* ml::DcmDRTIonRangeCompensatorSequenceInterface::getSequence (  )  const [inline]

Return the DRTIonRangeCompensatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIonRangeCompensatorSequence

Definition at line 155 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

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

Check if the DRTIonRangeCompensatorSequence is set.

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

Definition at line 161 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::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 196 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::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 207 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setAccessoryCode ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorColumnOffset ( unsigned long  idx,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorColumns ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorDivergence ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorMillingToolDiameter ( unsigned long  idx,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorMountingPosition ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorPixelSpacing ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorPosition ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorRelativeStoppingPowerRatio ( unsigned long  idx,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorRows ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorThicknessData ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setIsocenterToCompensatorDistances ( unsigned long  idx,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setIsocenterToCompensatorTrayDistance ( unsigned long  idx,
float &  parameter 
)

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setMaterialID ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTIonRangeCompensatorSequenceInterface::setSequence ( DRTIonRangeCompensatorSequence *  dcmSequence  )  [inline]

Set the DRTIonRangeCompensatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIonRangeCompensatorSequence

Definition at line 149 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

Member Data Documentation

DRTIonRangeCompensatorSequence* ml::DcmDRTIonRangeCompensatorSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 217 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

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