ml::DcmDRTIonBlockSequenceInterface Class Reference

Class to provide access to DRTIonBlockSequence. More...

#include <mlDcmDRTIonBlockSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTIonBlockSequenceInterface (DRTIonBlockSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTIonBlockSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter)
bool getAccessoryCode (DRTIonBlockSequence::Item &item, std::string &parameter)
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string &parameter)
bool getBlockData (unsigned long idx, std::string &parameter)
bool getBlockData (DRTIonBlockSequence::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 (DRTIonBlockSequence::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 (DRTIonBlockSequence::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 (DRTIonBlockSequence::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 (DRTIonBlockSequence::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 (DRTIonBlockSequence::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 (DRTIonBlockSequence::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 (DRTIonBlockSequence::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 (DRTIonBlockSequence::Item &item, std::string &parameter)
std::string getBlockTypeTag () const
bool setBlockType (unsigned long idx, std::string &parameter)
bool getIsocenterToBlockTrayDistance (unsigned long idx, float &parameter)
bool getIsocenterToBlockTrayDistance (DRTIonBlockSequence::Item &item, float &parameter)
std::string getIsocenterToBlockTrayDistanceTag () const
bool setIsocenterToBlockTrayDistance (unsigned long idx, float &parameter)
bool getMaterialID (unsigned long idx, std::string &parameter)
bool getMaterialID (DRTIonBlockSequence::Item &item, std::string &parameter)
std::string getMaterialIDTag () const
bool setMaterialID (unsigned long idx, std::string &parameter)
void setSequence (DRTIonBlockSequence *dcmSequence)
 Set the DRTIonBlockSequence this interface class provides access to.
DRTIonBlockSequence * getSequence () const
 Return the DRTIonBlockSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTIonBlockSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTIonBlockSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTIonBlockSequence::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

DRTIonBlockSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTIonBlockSequence.

Definition at line 42 of file mlDcmDRTIonBlockSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTIonBlockSequenceInterface::DcmDRTIonBlockSequenceInterface ( DRTIonBlockSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTIonBlockSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTIonBlockSequenceInterface.h.

Member Function Documentation

DRTIonBlockSequence::Item* ml::DcmDRTIonBlockSequenceInterface::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 161 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getAccessoryCode ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockData ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 59 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockDivergence ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 65 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockMountingPosition ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 71 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockName ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 77 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockNumber ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

bool ml::DcmDRTIonBlockSequenceInterface::getBlockNumberOfPoints ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 89 of file mlDcmDRTIonBlockSequenceInterface.h.

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

Definition at line 83 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockThickness ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 95 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockTrayID ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 101 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getBlockType ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 107 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getIsocenterToBlockTrayDistance ( DRTIonBlockSequence::Item &  item,
float &  parameter 
)

bool ml::DcmDRTIonBlockSequenceInterface::getIsocenterToBlockTrayDistance ( unsigned long  idx,
float &  parameter 
)

std::string ml::DcmDRTIonBlockSequenceInterface::getIsocenterToBlockTrayDistanceTag (  )  const [inline]

Definition at line 113 of file mlDcmDRTIonBlockSequenceInterface.h.

DRTIonBlockSequence::Item* ml::DcmDRTIonBlockSequenceInterface::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 152 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::getMaterialID ( DRTIonBlockSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 119 of file mlDcmDRTIonBlockSequenceInterface.h.

MLint ml::DcmDRTIonBlockSequenceInterface::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 143 of file mlDcmDRTIonBlockSequenceInterface.h.

DRTIonBlockSequence* ml::DcmDRTIonBlockSequenceInterface::getSequence (  )  const [inline]

Return the DRTIonBlockSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIonBlockSequence

Definition at line 131 of file mlDcmDRTIonBlockSequenceInterface.h.

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

Check if the DRTIonBlockSequence is set.

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

Definition at line 137 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::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 172 of file mlDcmDRTIonBlockSequenceInterface.h.

bool ml::DcmDRTIonBlockSequenceInterface::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 183 of file mlDcmDRTIonBlockSequenceInterface.h.

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

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

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

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

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

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

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

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

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

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

bool ml::DcmDRTIonBlockSequenceInterface::setIsocenterToBlockTrayDistance ( unsigned long  idx,
float &  parameter 
)

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

void ml::DcmDRTIonBlockSequenceInterface::setSequence ( DRTIonBlockSequence *  dcmSequence  )  [inline]

Set the DRTIonBlockSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIonBlockSequence

Definition at line 125 of file mlDcmDRTIonBlockSequenceInterface.h.

Member Data Documentation

DRTIonBlockSequence* ml::DcmDRTIonBlockSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 193 of file mlDcmDRTIonBlockSequenceInterface.h.

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