ml::DcmDRTSourceSequenceInterface Class Reference

Class to provide access to DRTSourceSequence. More...

#include <mlDcmDRTSourceSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTSourceSequenceInterface (DRTSourceSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTSourceSequenceInterface ()
 Default virtual Destructor.
bool getActiveSourceDiameter (unsigned long idx, std::string &parameter)
bool getActiveSourceDiameter (DRTSourceSequence::Item &item, std::string &parameter)
std::string getActiveSourceDiameterTag () const
bool setActiveSourceDiameter (unsigned long idx, std::string &parameter)
bool getActiveSourceLength (unsigned long idx, std::string &parameter)
bool getActiveSourceLength (DRTSourceSequence::Item &item, std::string &parameter)
std::string getActiveSourceLengthTag () const
bool setActiveSourceLength (unsigned long idx, std::string &parameter)
bool getMaterialID (unsigned long idx, std::string &parameter)
bool getMaterialID (DRTSourceSequence::Item &item, std::string &parameter)
std::string getMaterialIDTag () const
bool setMaterialID (unsigned long idx, std::string &parameter)
bool getReferenceAirKermaRate (unsigned long idx, std::string &parameter)
bool getReferenceAirKermaRate (DRTSourceSequence::Item &item, std::string &parameter)
std::string getReferenceAirKermaRateTag () const
bool setReferenceAirKermaRate (unsigned long idx, std::string &parameter)
bool getSourceEncapsulationNominalThickness (unsigned long idx, std::string &parameter)
bool getSourceEncapsulationNominalThickness (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceEncapsulationNominalThicknessTag () const
bool setSourceEncapsulationNominalThickness (unsigned long idx, std::string &parameter)
bool getSourceEncapsulationNominalTransmission (unsigned long idx, std::string &parameter)
bool getSourceEncapsulationNominalTransmission (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceEncapsulationNominalTransmissionTag () const
bool setSourceEncapsulationNominalTransmission (unsigned long idx, std::string &parameter)
bool getSourceIsotopeHalfLife (unsigned long idx, std::string &parameter)
bool getSourceIsotopeHalfLife (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceIsotopeHalfLifeTag () const
bool setSourceIsotopeHalfLife (unsigned long idx, std::string &parameter)
bool getSourceIsotopeName (unsigned long idx, std::string &parameter)
bool getSourceIsotopeName (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceIsotopeNameTag () const
bool setSourceIsotopeName (unsigned long idx, std::string &parameter)
bool getSourceManufacturer (unsigned long idx, std::string &parameter)
bool getSourceManufacturer (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceManufacturerTag () const
bool setSourceManufacturer (unsigned long idx, std::string &parameter)
bool getSourceNumber (unsigned long idx, std::string &parameter)
bool getSourceNumber (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceNumberTag () const
bool setSourceNumber (unsigned long idx, std::string &parameter)
bool getSourceStrength (unsigned long idx, std::string &parameter)
bool getSourceStrength (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceStrengthTag () const
bool setSourceStrength (unsigned long idx, std::string &parameter)
bool getSourceStrengthReferenceDate (unsigned long idx, std::string &parameter)
bool getSourceStrengthReferenceDate (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceStrengthReferenceDateTag () const
bool setSourceStrengthReferenceDate (unsigned long idx, std::string &parameter)
bool getSourceStrengthReferenceTime (unsigned long idx, std::string &parameter)
bool getSourceStrengthReferenceTime (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceStrengthReferenceTimeTag () const
bool setSourceStrengthReferenceTime (unsigned long idx, std::string &parameter)
bool getSourceStrengthUnits (unsigned long idx, std::string &parameter)
bool getSourceStrengthUnits (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceStrengthUnitsTag () const
bool setSourceStrengthUnits (unsigned long idx, std::string &parameter)
bool getSourceType (unsigned long idx, std::string &parameter)
bool getSourceType (DRTSourceSequence::Item &item, std::string &parameter)
std::string getSourceTypeTag () const
bool setSourceType (unsigned long idx, std::string &parameter)
void setSequence (DRTSourceSequence *dcmSequence)
 Set the DRTSourceSequence this interface class provides access to.
DRTSourceSequence * getSequence () const
 Return the DRTSourceSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTSourceSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTSourceSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTSourceSequence::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

DRTSourceSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTSourceSequence.

Definition at line 42 of file mlDcmDRTSourceSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTSourceSequenceInterface::DcmDRTSourceSequenceInterface ( DRTSourceSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTSourceSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTSourceSequenceInterface.h.

Member Function Documentation

DRTSourceSequence::Item* ml::DcmDRTSourceSequenceInterface::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 mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceDiameter ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceDiameter ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getActiveSourceDiameterTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceLength ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getActiveSourceLength ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getActiveSourceLengthTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTSourceSequenceInterface.h.

DRTSourceSequence::Item* ml::DcmDRTSourceSequenceInterface::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 mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getMaterialID ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 65 of file mlDcmDRTSourceSequenceInterface.h.

MLint ml::DcmDRTSourceSequenceInterface::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 mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getReferenceAirKermaRate ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getReferenceAirKermaRate ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getReferenceAirKermaRateTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTSourceSequenceInterface.h.

DRTSourceSequence* ml::DcmDRTSourceSequenceInterface::getSequence (  )  const [inline]

Return the DRTSourceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTSourceSequence

Definition at line 149 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalThickness ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalThickness ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalThicknessTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalTransmission ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalTransmission ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceEncapsulationNominalTransmissionTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeHalfLife ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeHalfLife ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceIsotopeHalfLifeTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeName ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceIsotopeName ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceIsotopeNameTag (  )  const [inline]

Definition at line 95 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceManufacturer ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceManufacturer ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceManufacturerTag (  )  const [inline]

Definition at line 101 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceNumber ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceNumberTag (  )  const [inline]

Definition at line 107 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceStrength ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceStrength ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceDate ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceDate ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceDateTag (  )  const [inline]

Definition at line 119 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceTime ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceTime ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthReferenceTimeTag (  )  const [inline]

Definition at line 125 of file mlDcmDRTSourceSequenceInterface.h.

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthUnits ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceStrengthUnits ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceStrengthUnitsTag (  )  const [inline]

Definition at line 131 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::getSourceType ( DRTSourceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::getSourceType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSourceSequenceInterface::getSourceTypeTag (  )  const [inline]

Definition at line 137 of file mlDcmDRTSourceSequenceInterface.h.

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

Check if the DRTSourceSequence is set.

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

Definition at line 155 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::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 mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::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 mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::setActiveSourceDiameter ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setActiveSourceLength ( unsigned long  idx,
std::string &  parameter 
)

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

bool ml::DcmDRTSourceSequenceInterface::setReferenceAirKermaRate ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTSourceSequenceInterface::setSequence ( DRTSourceSequence *  dcmSequence  )  [inline]

Set the DRTSourceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTSourceSequence

Definition at line 143 of file mlDcmDRTSourceSequenceInterface.h.

bool ml::DcmDRTSourceSequenceInterface::setSourceEncapsulationNominalThickness ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceEncapsulationNominalTransmission ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceIsotopeHalfLife ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceIsotopeName ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceManufacturer ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceStrength ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceStrengthReferenceDate ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceStrengthReferenceTime ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceStrengthUnits ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTSourceSequenceInterface::setSourceType ( unsigned long  idx,
std::string &  parameter 
)

Member Data Documentation

DRTSourceSequence* ml::DcmDRTSourceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 211 of file mlDcmDRTSourceSequenceInterface.h.

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