ml::DcmDRTBlockSequenceInterface Class Reference

Class to provide access to DRTBlockSequence. More...

#include <mlDcmDRTBlockSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTBlockSequenceInterface (DRTBlockSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTBlockSequenceInterface ()
 Default virtual Destructor.
bool getBlockData (unsigned long idx, std::string &parameter)
bool getBlockData (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockDataTag () const
bool setBlockData (unsigned long idx, std::string &parameter)
bool getBlockDivergence (unsigned long idx, std::string &parameter)
bool getBlockDivergence (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockDivergenceTag () const
bool setBlockDivergence (unsigned long idx, std::string &parameter)
bool getBlockMountingPosition (unsigned long idx, std::string &parameter)
bool getBlockMountingPosition (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockMountingPositionTag () const
bool setBlockMountingPosition (unsigned long idx, std::string &parameter)
bool getBlockName (unsigned long idx, std::string &parameter)
bool getBlockName (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockNameTag () const
bool setBlockName (unsigned long idx, std::string &parameter)
bool getBlockNumber (unsigned long idx, std::string &parameter)
bool getBlockNumber (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockNumberTag () const
bool setBlockNumber (unsigned long idx, std::string &parameter)
bool getBlockNumberOfPoints (unsigned long idx, std::string &parameter)
bool getBlockNumberOfPoints (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockNumberOfPointsTag () const
bool setBlockNumberOfPoints (unsigned long idx, std::string &parameter)
bool getBlockThickness (unsigned long idx, std::string &parameter)
bool getBlockThickness (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockThicknessTag () const
bool setBlockThickness (unsigned long idx, std::string &parameter)
bool getBlockTrayID (unsigned long idx, std::string &parameter)
bool getBlockTrayID (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockTrayIDTag () const
bool setBlockTrayID (unsigned long idx, std::string &parameter)
bool getBlockType (unsigned long idx, std::string &parameter)
bool getBlockType (DRTBlockSequence::Item &item, std::string &parameter)
std::string getBlockTypeTag () const
bool setBlockType (unsigned long idx, std::string &parameter)
bool getMaterialID (unsigned long idx, std::string &parameter)
bool getMaterialID (DRTBlockSequence::Item &item, std::string &parameter)
std::string getMaterialIDTag () const
bool setMaterialID (unsigned long idx, std::string &parameter)
bool getSourceToBlockTrayDistance (unsigned long idx, std::string &parameter)
bool getSourceToBlockTrayDistance (DRTBlockSequence::Item &item, std::string &parameter)
std::string getSourceToBlockTrayDistanceTag () const
bool setSourceToBlockTrayDistance (unsigned long idx, std::string &parameter)
void setSequence (DRTBlockSequence *dcmSequence)
 Set the DRTBlockSequence this interface class provides access to.
DRTBlockSequence * getSequence () const
 Return the DRTBlockSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTBlockSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTBlockSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTBlockSequence::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

DRTBlockSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTBlockSequence.

Definition at line 42 of file mlDcmDRTBlockSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTBlockSequenceInterface::DcmDRTBlockSequenceInterface ( DRTBlockSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTBlockSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTBlockSequenceInterface.h.

Member Function Documentation

DRTBlockSequence::Item* ml::DcmDRTBlockSequenceInterface::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 155 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockData ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockData ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockDataTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockDivergence ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockDivergence ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockDivergenceTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockMountingPosition ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockMountingPosition ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockMountingPositionTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockName ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockName ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockNameTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockNumber ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockNumberOfPoints ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockNumberOfPoints ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockNumberOfPointsTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTBlockSequenceInterface.h.

std::string ml::DcmDRTBlockSequenceInterface::getBlockNumberTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockThickness ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockThickness ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockThicknessTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockTrayID ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockTrayID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockTrayIDTag (  )  const [inline]

Definition at line 95 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getBlockType ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getBlockType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getBlockTypeTag (  )  const [inline]

Definition at line 101 of file mlDcmDRTBlockSequenceInterface.h.

DRTBlockSequence::Item* ml::DcmDRTBlockSequenceInterface::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 146 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getMaterialID ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 107 of file mlDcmDRTBlockSequenceInterface.h.

MLint ml::DcmDRTBlockSequenceInterface::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 137 of file mlDcmDRTBlockSequenceInterface.h.

DRTBlockSequence* ml::DcmDRTBlockSequenceInterface::getSequence (  )  const [inline]

Return the DRTBlockSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTBlockSequence

Definition at line 125 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::getSourceToBlockTrayDistance ( DRTBlockSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::getSourceToBlockTrayDistance ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTBlockSequenceInterface::getSourceToBlockTrayDistanceTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTBlockSequenceInterface.h.

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

Check if the DRTBlockSequence is set.

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

Definition at line 131 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::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 166 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::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 177 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::setBlockData ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockDivergence ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockMountingPosition ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockName ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockNumberOfPoints ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockThickness ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockTrayID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTBlockSequenceInterface::setBlockType ( unsigned long  idx,
std::string &  parameter 
)

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

void ml::DcmDRTBlockSequenceInterface::setSequence ( DRTBlockSequence *  dcmSequence  )  [inline]

Set the DRTBlockSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTBlockSequence

Definition at line 119 of file mlDcmDRTBlockSequenceInterface.h.

bool ml::DcmDRTBlockSequenceInterface::setSourceToBlockTrayDistance ( unsigned long  idx,
std::string &  parameter 
)

Member Data Documentation

DRTBlockSequence* ml::DcmDRTBlockSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 187 of file mlDcmDRTBlockSequenceInterface.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