ml::DcmDRTMotionSynchronizationSequenceInterface Class Reference

Class to provide access to DRTMotionSynchronizationSequence. More...

#include <mlDcmDRTMotionSynchronizationSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTMotionSynchronizationSequenceInterface (DRTMotionSynchronizationSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTMotionSynchronizationSequenceInterface ()
 Default virtual Destructor.
bool getRespiratoryMotionCompensationTechnique (unsigned long idx, std::string &parameter)
bool getRespiratoryMotionCompensationTechnique (DRTMotionSynchronizationSequence::Item &item, std::string &parameter)
std::string getRespiratoryMotionCompensationTechniqueTag () const
bool setRespiratoryMotionCompensationTechnique (unsigned long idx, std::string &parameter)
bool getRespiratoryMotionCompensationTechniqueDescription (unsigned long idx, std::string &parameter)
bool getRespiratoryMotionCompensationTechniqueDescription (DRTMotionSynchronizationSequence::Item &item, std::string &parameter)
std::string getRespiratoryMotionCompensationTechniqueDescriptionTag () const
bool setRespiratoryMotionCompensationTechniqueDescription (unsigned long idx, std::string &parameter)
bool getRespiratorySignalSource (unsigned long idx, std::string &parameter)
bool getRespiratorySignalSource (DRTMotionSynchronizationSequence::Item &item, std::string &parameter)
std::string getRespiratorySignalSourceTag () const
bool setRespiratorySignalSource (unsigned long idx, std::string &parameter)
bool getRespiratorySignalSourceID (unsigned long idx, std::string &parameter)
bool getRespiratorySignalSourceID (DRTMotionSynchronizationSequence::Item &item, std::string &parameter)
std::string getRespiratorySignalSourceIDTag () const
bool setRespiratorySignalSourceID (unsigned long idx, std::string &parameter)
void setSequence (DRTMotionSynchronizationSequence *dcmSequence)
 Set the DRTMotionSynchronizationSequence this interface class provides access to.
DRTMotionSynchronizationSequence * getSequence () const
 Return the DRTMotionSynchronizationSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTMotionSynchronizationSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTMotionSynchronizationSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTMotionSynchronizationSequence::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

DRTMotionSynchronizationSequence * _dcmSequence
 Reference to the wrapped DcmSequence.


Detailed Description

Class to provide access to DRTMotionSynchronizationSequence.

Definition at line 42 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.


Constructor & Destructor Documentation

ml::DcmDRTMotionSynchronizationSequenceInterface::DcmDRTMotionSynchronizationSequenceInterface ( DRTMotionSynchronizationSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.


Member Function Documentation

DRTMotionSynchronizationSequence::Item* ml::DcmDRTMotionSynchronizationSequenceInterface::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 113 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

DRTMotionSynchronizationSequence::Item* ml::DcmDRTMotionSynchronizationSequenceInterface::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 104 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

MLint ml::DcmDRTMotionSynchronizationSequenceInterface::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 95 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechnique ( DRTMotionSynchronizationSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechnique ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueDescription ( DRTMotionSynchronizationSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueDescription ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueDescriptionTag (  )  const [inline]

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueTag (  )  const [inline]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSource ( DRTMotionSynchronizationSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSource ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceID ( DRTMotionSynchronizationSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceIDTag (  )  const [inline]

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceTag (  )  const [inline]

DRTMotionSynchronizationSequence* ml::DcmDRTMotionSynchronizationSequenceInterface::getSequence (  )  const [inline]

Return the DRTMotionSynchronizationSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTMotionSynchronizationSequence

Definition at line 83 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

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

Check if the DRTMotionSynchronizationSequence is set.

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

Definition at line 89 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

bool ml::DcmDRTMotionSynchronizationSequenceInterface::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 124 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

bool ml::DcmDRTMotionSynchronizationSequenceInterface::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 135 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratoryMotionCompensationTechnique ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratoryMotionCompensationTechniqueDescription ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratorySignalSource ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratorySignalSourceID ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTMotionSynchronizationSequenceInterface::setSequence ( DRTMotionSynchronizationSequence *  dcmSequence  )  [inline]

Set the DRTMotionSynchronizationSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTMotionSynchronizationSequence

Definition at line 77 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.


Member Data Documentation

DRTMotionSynchronizationSequence* ml::DcmDRTMotionSynchronizationSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 145 of file mlDcmDRTMotionSynchronizationSequenceInterface.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