ml::DcmDRTIonWedgeSequenceInterface Class Reference

Class to provide access to DRTIonWedgeSequence. More...

#include <mlDcmDRTIonWedgeSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTIonWedgeSequenceInterface (DRTIonWedgeSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTIonWedgeSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter)
bool getAccessoryCode (DRTIonWedgeSequence::Item &item, std::string &parameter)
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string &parameter)
bool getIsocenterToWedgeTrayDistance (unsigned long idx, float &parameter)
bool getIsocenterToWedgeTrayDistance (DRTIonWedgeSequence::Item &item, float &parameter)
std::string getIsocenterToWedgeTrayDistanceTag () const
bool setIsocenterToWedgeTrayDistance (unsigned long idx, float &parameter)
bool getWedgeAngle (unsigned long idx, std::string &parameter)
bool getWedgeAngle (DRTIonWedgeSequence::Item &item, std::string &parameter)
std::string getWedgeAngleTag () const
bool setWedgeAngle (unsigned long idx, std::string &parameter)
bool getWedgeID (unsigned long idx, std::string &parameter)
bool getWedgeID (DRTIonWedgeSequence::Item &item, std::string &parameter)
std::string getWedgeIDTag () const
bool setWedgeID (unsigned long idx, std::string &parameter)
bool getWedgeNumber (unsigned long idx, std::string &parameter)
bool getWedgeNumber (DRTIonWedgeSequence::Item &item, std::string &parameter)
std::string getWedgeNumberTag () const
bool setWedgeNumber (unsigned long idx, std::string &parameter)
bool getWedgeOrientation (unsigned long idx, std::string &parameter)
bool getWedgeOrientation (DRTIonWedgeSequence::Item &item, std::string &parameter)
std::string getWedgeOrientationTag () const
bool setWedgeOrientation (unsigned long idx, std::string &parameter)
bool getWedgeType (unsigned long idx, std::string &parameter)
bool getWedgeType (DRTIonWedgeSequence::Item &item, std::string &parameter)
std::string getWedgeTypeTag () const
bool setWedgeType (unsigned long idx, std::string &parameter)
void setSequence (DRTIonWedgeSequence *dcmSequence)
 Set the DRTIonWedgeSequence this interface class provides access to.
DRTIonWedgeSequence * getSequence () const
 Return the DRTIonWedgeSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTIonWedgeSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTIonWedgeSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTIonWedgeSequence::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

DRTIonWedgeSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTIonWedgeSequence.

Definition at line 42 of file mlDcmDRTIonWedgeSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTIonWedgeSequenceInterface::DcmDRTIonWedgeSequenceInterface ( DRTIonWedgeSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTIonWedgeSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTIonWedgeSequenceInterface.h.

Member Function Documentation

DRTIonWedgeSequence::Item* ml::DcmDRTIonWedgeSequenceInterface::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 mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::getAccessoryCode ( DRTIonWedgeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::getIsocenterToWedgeTrayDistance ( DRTIonWedgeSequence::Item &  item,
float &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::getIsocenterToWedgeTrayDistance ( unsigned long  idx,
float &  parameter 
)

std::string ml::DcmDRTIonWedgeSequenceInterface::getIsocenterToWedgeTrayDistanceTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTIonWedgeSequenceInterface.h.

DRTIonWedgeSequence::Item* ml::DcmDRTIonWedgeSequenceInterface::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 mlDcmDRTIonWedgeSequenceInterface.h.

MLint ml::DcmDRTIonWedgeSequenceInterface::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 mlDcmDRTIonWedgeSequenceInterface.h.

DRTIonWedgeSequence* ml::DcmDRTIonWedgeSequenceInterface::getSequence (  )  const [inline]

Return the DRTIonWedgeSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIonWedgeSequence

Definition at line 101 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeAngle ( DRTIonWedgeSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeAngle ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonWedgeSequenceInterface::getWedgeAngleTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeID ( DRTIonWedgeSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonWedgeSequenceInterface::getWedgeIDTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeNumber ( DRTIonWedgeSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonWedgeSequenceInterface::getWedgeNumberTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeOrientation ( DRTIonWedgeSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeOrientation ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonWedgeSequenceInterface::getWedgeOrientationTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeType ( DRTIonWedgeSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::getWedgeType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTIonWedgeSequenceInterface::getWedgeTypeTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTIonWedgeSequenceInterface.h.

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

Check if the DRTIonWedgeSequence is set.

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

Definition at line 107 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::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 mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::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 mlDcmDRTIonWedgeSequenceInterface.h.

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

bool ml::DcmDRTIonWedgeSequenceInterface::setIsocenterToWedgeTrayDistance ( unsigned long  idx,
float &  parameter 
)

void ml::DcmDRTIonWedgeSequenceInterface::setSequence ( DRTIonWedgeSequence *  dcmSequence  )  [inline]

Set the DRTIonWedgeSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTIonWedgeSequence

Definition at line 95 of file mlDcmDRTIonWedgeSequenceInterface.h.

bool ml::DcmDRTIonWedgeSequenceInterface::setWedgeAngle ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::setWedgeID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::setWedgeNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::setWedgeOrientation ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTIonWedgeSequenceInterface::setWedgeType ( unsigned long  idx,
std::string &  parameter 
)

Member Data Documentation

DRTIonWedgeSequence* ml::DcmDRTIonWedgeSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 163 of file mlDcmDRTIonWedgeSequenceInterface.h.

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