ml::DcmDRTSnoutSequenceInterface Class Reference

Class to provide access to DRTSnoutSequence. More...

#include <mlDcmDRTSnoutSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTSnoutSequenceInterface (DRTSnoutSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTSnoutSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter)
bool getAccessoryCode (DRTSnoutSequence::Item &item, std::string &parameter)
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string &parameter)
bool getSnoutID (unsigned long idx, std::string &parameter)
bool getSnoutID (DRTSnoutSequence::Item &item, std::string &parameter)
std::string getSnoutIDTag () const
bool setSnoutID (unsigned long idx, std::string &parameter)
void setSequence (DRTSnoutSequence *dcmSequence)
 Set the DRTSnoutSequence this interface class provides access to.
DRTSnoutSequence * getSequence () const
 Return the DRTSnoutSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTSnoutSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTSnoutSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTSnoutSequence::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

DRTSnoutSequence * _dcmSequence
 Reference to the wrapped DcmSequence.


Detailed Description

Class to provide access to DRTSnoutSequence.

Definition at line 42 of file mlDcmDRTSnoutSequenceInterface.h.


Constructor & Destructor Documentation

ml::DcmDRTSnoutSequenceInterface::DcmDRTSnoutSequenceInterface ( DRTSnoutSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTSnoutSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTSnoutSequenceInterface.h.


Member Function Documentation

DRTSnoutSequence::Item* ml::DcmDRTSnoutSequenceInterface::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 101 of file mlDcmDRTSnoutSequenceInterface.h.

bool ml::DcmDRTSnoutSequenceInterface::getAccessoryCode ( DRTSnoutSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTSnoutSequenceInterface.h.

DRTSnoutSequence::Item* ml::DcmDRTSnoutSequenceInterface::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 92 of file mlDcmDRTSnoutSequenceInterface.h.

MLint ml::DcmDRTSnoutSequenceInterface::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 83 of file mlDcmDRTSnoutSequenceInterface.h.

DRTSnoutSequence* ml::DcmDRTSnoutSequenceInterface::getSequence (  )  const [inline]

Return the DRTSnoutSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTSnoutSequence

Definition at line 71 of file mlDcmDRTSnoutSequenceInterface.h.

bool ml::DcmDRTSnoutSequenceInterface::getSnoutID ( DRTSnoutSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTSnoutSequenceInterface::getSnoutID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTSnoutSequenceInterface::getSnoutIDTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTSnoutSequenceInterface.h.

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

Check if the DRTSnoutSequence is set.

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

Definition at line 77 of file mlDcmDRTSnoutSequenceInterface.h.

bool ml::DcmDRTSnoutSequenceInterface::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 112 of file mlDcmDRTSnoutSequenceInterface.h.

bool ml::DcmDRTSnoutSequenceInterface::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 123 of file mlDcmDRTSnoutSequenceInterface.h.

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

void ml::DcmDRTSnoutSequenceInterface::setSequence ( DRTSnoutSequence *  dcmSequence  )  [inline]

Set the DRTSnoutSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTSnoutSequence

Definition at line 65 of file mlDcmDRTSnoutSequenceInterface.h.

bool ml::DcmDRTSnoutSequenceInterface::setSnoutID ( unsigned long  idx,
std::string &  parameter 
)


Member Data Documentation

DRTSnoutSequence* ml::DcmDRTSnoutSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 133 of file mlDcmDRTSnoutSequenceInterface.h.


The documentation for this class was generated from the following file:

Generated on Sat Sep 3 18:39:48 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8