ml::DcmDRTRecordedRangeModulatorSequenceInterface Class Reference

Class to provide access to DRTRecordedRangeModulatorSequence. More...

#include <mlDcmDRTRecordedRangeModulatorSequenceInterface.h>

List of all members.

Public Member Functions

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

DRTRecordedRangeModulatorSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTRecordedRangeModulatorSequence.

Definition at line 42 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTRecordedRangeModulatorSequenceInterface::DcmDRTRecordedRangeModulatorSequenceInterface ( DRTRecordedRangeModulatorSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Member Function Documentation

DRTRecordedRangeModulatorSequence::Item* ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 119 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getAccessoryCode ( DRTRecordedRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getBeamCurrentModulationID ( DRTRecordedRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 59 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

DRTRecordedRangeModulatorSequence::Item* ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 110 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

MLint ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 101 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorID ( DRTRecordedRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 65 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorType ( DRTRecordedRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 71 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getReferencedRangeModulatorNumber ( DRTRecordedRangeModulatorSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getReferencedRangeModulatorNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTRecordedRangeModulatorSequenceInterface::getReferencedRangeModulatorNumberTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

DRTRecordedRangeModulatorSequence* ml::DcmDRTRecordedRangeModulatorSequenceInterface::getSequence (  )  const [inline]

Return the DRTRecordedRangeModulatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRecordedRangeModulatorSequence

Definition at line 89 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

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

Check if the DRTRecordedRangeModulatorSequence is set.

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

Definition at line 95 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 130 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 141 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

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

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

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

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

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::setReferencedRangeModulatorNumber ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTRecordedRangeModulatorSequenceInterface::setSequence ( DRTRecordedRangeModulatorSequence *  dcmSequence  )  [inline]

Set the DRTRecordedRangeModulatorSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRecordedRangeModulatorSequence

Definition at line 83 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Member Data Documentation

DRTRecordedRangeModulatorSequence* ml::DcmDRTRecordedRangeModulatorSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 151 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.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