ml::DcmDRTCompensatorSequenceInterface Class Reference

Class to provide access to DRTCompensatorSequence. More...

#include <mlDcmDRTCompensatorSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTCompensatorSequenceInterface (DRTCompensatorSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTCompensatorSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter)
bool getAccessoryCode (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string &parameter)
bool getCompensatorColumns (unsigned long idx, std::string &parameter)
bool getCompensatorColumns (DRTCompensatorSequence::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 (DRTCompensatorSequence::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 (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorIDTag () const
bool setCompensatorID (unsigned long idx, std::string &parameter)
bool getCompensatorMountingPosition (unsigned long idx, std::string &parameter)
bool getCompensatorMountingPosition (DRTCompensatorSequence::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 (DRTCompensatorSequence::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 (DRTCompensatorSequence::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 (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorPositionTag () const
bool setCompensatorPosition (unsigned long idx, std::string &parameter)
bool getCompensatorRows (unsigned long idx, std::string &parameter)
bool getCompensatorRows (DRTCompensatorSequence::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 (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorThicknessDataTag () const
bool setCompensatorThicknessData (unsigned long idx, std::string &parameter)
bool getCompensatorTransmissionData (unsigned long idx, std::string &parameter)
bool getCompensatorTransmissionData (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorTransmissionDataTag () const
bool setCompensatorTransmissionData (unsigned long idx, std::string &parameter)
bool getCompensatorType (unsigned long idx, std::string &parameter)
bool getCompensatorType (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getCompensatorTypeTag () const
bool setCompensatorType (unsigned long idx, std::string &parameter)
bool getMaterialID (unsigned long idx, std::string &parameter)
bool getMaterialID (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getMaterialIDTag () const
bool setMaterialID (unsigned long idx, std::string &parameter)
bool getSourceToCompensatorDistance (unsigned long idx, std::string &parameter)
bool getSourceToCompensatorDistance (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getSourceToCompensatorDistanceTag () const
bool setSourceToCompensatorDistance (unsigned long idx, std::string &parameter)
bool getSourceToCompensatorTrayDistance (unsigned long idx, std::string &parameter)
bool getSourceToCompensatorTrayDistance (DRTCompensatorSequence::Item &item, std::string &parameter)
std::string getSourceToCompensatorTrayDistanceTag () const
bool setSourceToCompensatorTrayDistance (unsigned long idx, std::string &parameter)
void setSequence (DRTCompensatorSequence *dcmSequence)
 Set the DRTCompensatorSequence this interface class provides access to.
DRTCompensatorSequence * getSequence () const
 Return the DRTCompensatorSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTCompensatorSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTCompensatorSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTCompensatorSequence::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

DRTCompensatorSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTCompensatorSequence.

Definition at line 42 of file mlDcmDRTCompensatorSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTCompensatorSequenceInterface::DcmDRTCompensatorSequenceInterface ( DRTCompensatorSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTCompensatorSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTCompensatorSequenceInterface.h.

Member Function Documentation

DRTCompensatorSequence::Item* ml::DcmDRTCompensatorSequenceInterface::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 179 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getAccessoryCode ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorColumns ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 59 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorDivergence ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 65 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorID ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 71 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorMountingPosition ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 77 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorNumber ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 83 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorPixelSpacing ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 89 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorPosition ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 95 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorRows ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 101 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorThicknessData ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 107 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorTransmissionData ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorTransmissionData ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorTransmissionDataTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorType ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTCompensatorSequenceInterface::getCompensatorType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTCompensatorSequenceInterface::getCompensatorTypeTag (  )  const [inline]

Definition at line 119 of file mlDcmDRTCompensatorSequenceInterface.h.

DRTCompensatorSequence::Item* ml::DcmDRTCompensatorSequenceInterface::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 170 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getMaterialID ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 125 of file mlDcmDRTCompensatorSequenceInterface.h.

MLint ml::DcmDRTCompensatorSequenceInterface::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 161 of file mlDcmDRTCompensatorSequenceInterface.h.

DRTCompensatorSequence* ml::DcmDRTCompensatorSequenceInterface::getSequence (  )  const [inline]

Return the DRTCompensatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTCompensatorSequence

Definition at line 149 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorDistance ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorDistance ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorDistanceTag (  )  const [inline]

Definition at line 131 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorTrayDistance ( DRTCompensatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorTrayDistance ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTCompensatorSequenceInterface::getSourceToCompensatorTrayDistanceTag (  )  const [inline]

Definition at line 137 of file mlDcmDRTCompensatorSequenceInterface.h.

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

Check if the DRTCompensatorSequence is set.

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

Definition at line 155 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::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 190 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::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 201 of file mlDcmDRTCompensatorSequenceInterface.h.

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

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

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

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

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

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

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

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

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

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

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorTransmissionData ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTCompensatorSequenceInterface::setCompensatorType ( unsigned long  idx,
std::string &  parameter 
)

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

void ml::DcmDRTCompensatorSequenceInterface::setSequence ( DRTCompensatorSequence *  dcmSequence  )  [inline]

Set the DRTCompensatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTCompensatorSequence

Definition at line 143 of file mlDcmDRTCompensatorSequenceInterface.h.

bool ml::DcmDRTCompensatorSequenceInterface::setSourceToCompensatorDistance ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTCompensatorSequenceInterface::setSourceToCompensatorTrayDistance ( unsigned long  idx,
std::string &  parameter 
)

Member Data Documentation

DRTCompensatorSequence* ml::DcmDRTCompensatorSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 211 of file mlDcmDRTCompensatorSequenceInterface.h.

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