ml::DcmDRTRangeModulatorSequenceInterface Class Reference

Class to provide access to DRTRangeModulatorSequence. More...

#include <mlDcmDRTRangeModulatorSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTRangeModulatorSequenceInterface (DRTRangeModulatorSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTRangeModulatorSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter)
bool getAccessoryCode (DRTRangeModulatorSequence::Item &item, std::string &parameter)
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string &parameter)
bool getBeamCurrentModulationID (unsigned long idx, std::string &parameter)
bool getBeamCurrentModulationID (DRTRangeModulatorSequence::Item &item, std::string &parameter)
std::string getBeamCurrentModulationIDTag () const
bool setBeamCurrentModulationID (unsigned long idx, std::string &parameter)
bool getRangeModulatorDescription (unsigned long idx, std::string &parameter)
bool getRangeModulatorDescription (DRTRangeModulatorSequence::Item &item, std::string &parameter)
std::string getRangeModulatorDescriptionTag () const
bool setRangeModulatorDescription (unsigned long idx, std::string &parameter)
bool getRangeModulatorID (unsigned long idx, std::string &parameter)
bool getRangeModulatorID (DRTRangeModulatorSequence::Item &item, std::string &parameter)
std::string getRangeModulatorIDTag () const
bool setRangeModulatorID (unsigned long idx, std::string &parameter)
bool getRangeModulatorNumber (unsigned long idx, std::string &parameter)
bool getRangeModulatorNumber (DRTRangeModulatorSequence::Item &item, std::string &parameter)
std::string getRangeModulatorNumberTag () const
bool setRangeModulatorNumber (unsigned long idx, std::string &parameter)
bool getRangeModulatorType (unsigned long idx, std::string &parameter)
bool getRangeModulatorType (DRTRangeModulatorSequence::Item &item, std::string &parameter)
std::string getRangeModulatorTypeTag () const
bool setRangeModulatorType (unsigned long idx, std::string &parameter)
void setSequence (DRTRangeModulatorSequence *dcmSequence)
 Set the DRTRangeModulatorSequence this interface class provides access to.
DRTRangeModulatorSequence * getSequence () const
 Return the DRTRangeModulatorSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTRangeModulatorSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTRangeModulatorSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTRangeModulatorSequence::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

DRTRangeModulatorSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTRangeModulatorSequence.

Definition at line 42 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTRangeModulatorSequenceInterface::DcmDRTRangeModulatorSequenceInterface ( DRTRangeModulatorSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRangeModulatorSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Member Function Documentation

DRTRangeModulatorSequence::Item* ml::DcmDRTRangeModulatorSequenceInterface::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 125 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::getAccessoryCode ( DRTRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::getBeamCurrentModulationID ( DRTRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::getBeamCurrentModulationID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTRangeModulatorSequenceInterface::getBeamCurrentModulationIDTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTRangeModulatorSequenceInterface.h.

DRTRangeModulatorSequence::Item* ml::DcmDRTRangeModulatorSequenceInterface::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 116 of file mlDcmDRTRangeModulatorSequenceInterface.h.

MLint ml::DcmDRTRangeModulatorSequenceInterface::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 107 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorDescription ( DRTRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorDescription ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorDescriptionTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorID ( DRTRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorIDTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorNumber ( DRTRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorNumberTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorType ( DRTRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorType ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorTypeTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTRangeModulatorSequenceInterface.h.

DRTRangeModulatorSequence* ml::DcmDRTRangeModulatorSequenceInterface::getSequence (  )  const [inline]

Return the DRTRangeModulatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRangeModulatorSequence

Definition at line 95 of file mlDcmDRTRangeModulatorSequenceInterface.h.

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

Check if the DRTRangeModulatorSequence is set.

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

Definition at line 101 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::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 136 of file mlDcmDRTRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRangeModulatorSequenceInterface::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 147 of file mlDcmDRTRangeModulatorSequenceInterface.h.

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

bool ml::DcmDRTRangeModulatorSequenceInterface::setBeamCurrentModulationID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorDescription ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorType ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTRangeModulatorSequenceInterface::setSequence ( DRTRangeModulatorSequence *  dcmSequence  )  [inline]

Set the DRTRangeModulatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRangeModulatorSequence

Definition at line 89 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Member Data Documentation

DRTRangeModulatorSequence* ml::DcmDRTRangeModulatorSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 157 of file mlDcmDRTRangeModulatorSequenceInterface.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