ml::DcmDRTChannelShieldSequenceInterface Class Reference

Class to provide access to DRTChannelShieldSequence. More...

#include <mlDcmDRTChannelShieldSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTChannelShieldSequenceInterface (DRTChannelShieldSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTChannelShieldSequenceInterface ()
 Default virtual Destructor.
bool getChannelShieldID (unsigned long idx, std::string &parameter)
bool getChannelShieldID (DRTChannelShieldSequence::Item &item, std::string &parameter)
std::string getChannelShieldIDTag () const
bool setChannelShieldID (unsigned long idx, std::string &parameter)
bool getChannelShieldName (unsigned long idx, std::string &parameter)
bool getChannelShieldName (DRTChannelShieldSequence::Item &item, std::string &parameter)
std::string getChannelShieldNameTag () const
bool setChannelShieldName (unsigned long idx, std::string &parameter)
bool getChannelShieldNominalThickness (unsigned long idx, std::string &parameter)
bool getChannelShieldNominalThickness (DRTChannelShieldSequence::Item &item, std::string &parameter)
std::string getChannelShieldNominalThicknessTag () const
bool setChannelShieldNominalThickness (unsigned long idx, std::string &parameter)
bool getChannelShieldNominalTransmission (unsigned long idx, std::string &parameter)
bool getChannelShieldNominalTransmission (DRTChannelShieldSequence::Item &item, std::string &parameter)
std::string getChannelShieldNominalTransmissionTag () const
bool setChannelShieldNominalTransmission (unsigned long idx, std::string &parameter)
bool getChannelShieldNumber (unsigned long idx, std::string &parameter)
bool getChannelShieldNumber (DRTChannelShieldSequence::Item &item, std::string &parameter)
std::string getChannelShieldNumberTag () const
bool setChannelShieldNumber (unsigned long idx, std::string &parameter)
bool getMaterialID (unsigned long idx, std::string &parameter)
bool getMaterialID (DRTChannelShieldSequence::Item &item, std::string &parameter)
std::string getMaterialIDTag () const
bool setMaterialID (unsigned long idx, std::string &parameter)
bool getReferencedROINumber (unsigned long idx, std::string &parameter)
bool getReferencedROINumber (DRTChannelShieldSequence::Item &item, std::string &parameter)
std::string getReferencedROINumberTag () const
bool setReferencedROINumber (unsigned long idx, std::string &parameter)
void setSequence (DRTChannelShieldSequence *dcmSequence)
 Set the DRTChannelShieldSequence this interface class provides access to.
DRTChannelShieldSequence * getSequence () const
 Return the DRTChannelShieldSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTChannelShieldSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTChannelShieldSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTChannelShieldSequence::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

DRTChannelShieldSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTChannelShieldSequence.

Definition at line 42 of file mlDcmDRTChannelShieldSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTChannelShieldSequenceInterface::DcmDRTChannelShieldSequenceInterface ( DRTChannelShieldSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTChannelShieldSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTChannelShieldSequenceInterface.h.

Member Function Documentation

DRTChannelShieldSequence::Item* ml::DcmDRTChannelShieldSequenceInterface::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 131 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldID ( DRTChannelShieldSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldIDTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldName ( DRTChannelShieldSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldName ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNameTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalThickness ( DRTChannelShieldSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalThickness ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalThicknessTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalTransmission ( DRTChannelShieldSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalTransmission ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNominalTransmissionTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNumber ( DRTChannelShieldSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTChannelShieldSequenceInterface::getChannelShieldNumberTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTChannelShieldSequenceInterface.h.

DRTChannelShieldSequence::Item* ml::DcmDRTChannelShieldSequenceInterface::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 122 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::getMaterialID ( DRTChannelShieldSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 83 of file mlDcmDRTChannelShieldSequenceInterface.h.

MLint ml::DcmDRTChannelShieldSequenceInterface::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 113 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::getReferencedROINumber ( DRTChannelShieldSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::getReferencedROINumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTChannelShieldSequenceInterface::getReferencedROINumberTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTChannelShieldSequenceInterface.h.

DRTChannelShieldSequence* ml::DcmDRTChannelShieldSequenceInterface::getSequence (  )  const [inline]

Return the DRTChannelShieldSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTChannelShieldSequence

Definition at line 101 of file mlDcmDRTChannelShieldSequenceInterface.h.

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

Check if the DRTChannelShieldSequence is set.

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

Definition at line 107 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::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 142 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::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 153 of file mlDcmDRTChannelShieldSequenceInterface.h.

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldName ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldNominalThickness ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldNominalTransmission ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTChannelShieldSequenceInterface::setChannelShieldNumber ( unsigned long  idx,
std::string &  parameter 
)

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

bool ml::DcmDRTChannelShieldSequenceInterface::setReferencedROINumber ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTChannelShieldSequenceInterface::setSequence ( DRTChannelShieldSequence *  dcmSequence  )  [inline]

Set the DRTChannelShieldSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTChannelShieldSequence

Definition at line 95 of file mlDcmDRTChannelShieldSequenceInterface.h.

Member Data Documentation

DRTChannelShieldSequence* ml::DcmDRTChannelShieldSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 163 of file mlDcmDRTChannelShieldSequenceInterface.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