ml::DcmDRTRecordedSnoutSequenceInterface Class Reference

Class to provide access to DRTRecordedSnoutSequence. More...

#include <mlDcmDRTRecordedSnoutSequenceInterface.h>

List of all members.

Public Member Functions

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

DRTRecordedSnoutSequence * _dcmSequence
 Reference to the wrapped DcmSequence.


Detailed Description

Class to provide access to DRTRecordedSnoutSequence.

Definition at line 42 of file mlDcmDRTRecordedSnoutSequenceInterface.h.


Constructor & Destructor Documentation

ml::DcmDRTRecordedSnoutSequenceInterface::DcmDRTRecordedSnoutSequenceInterface ( DRTRecordedSnoutSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRecordedSnoutSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRecordedSnoutSequenceInterface.h.


Member Function Documentation

DRTRecordedSnoutSequence::Item* ml::DcmDRTRecordedSnoutSequenceInterface::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 mlDcmDRTRecordedSnoutSequenceInterface.h.

bool ml::DcmDRTRecordedSnoutSequenceInterface::getAccessoryCode ( DRTRecordedSnoutSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTRecordedSnoutSequenceInterface.h.

DRTRecordedSnoutSequence::Item* ml::DcmDRTRecordedSnoutSequenceInterface::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 mlDcmDRTRecordedSnoutSequenceInterface.h.

MLint ml::DcmDRTRecordedSnoutSequenceInterface::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 mlDcmDRTRecordedSnoutSequenceInterface.h.

DRTRecordedSnoutSequence* ml::DcmDRTRecordedSnoutSequenceInterface::getSequence (  )  const [inline]

Return the DRTRecordedSnoutSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRecordedSnoutSequence

Definition at line 71 of file mlDcmDRTRecordedSnoutSequenceInterface.h.

bool ml::DcmDRTRecordedSnoutSequenceInterface::getSnoutID ( DRTRecordedSnoutSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 59 of file mlDcmDRTRecordedSnoutSequenceInterface.h.

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

Check if the DRTRecordedSnoutSequence is set.

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

Definition at line 77 of file mlDcmDRTRecordedSnoutSequenceInterface.h.

bool ml::DcmDRTRecordedSnoutSequenceInterface::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 mlDcmDRTRecordedSnoutSequenceInterface.h.

bool ml::DcmDRTRecordedSnoutSequenceInterface::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 mlDcmDRTRecordedSnoutSequenceInterface.h.

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

void ml::DcmDRTRecordedSnoutSequenceInterface::setSequence ( DRTRecordedSnoutSequence *  dcmSequence  )  [inline]

Set the DRTRecordedSnoutSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRecordedSnoutSequence

Definition at line 65 of file mlDcmDRTRecordedSnoutSequenceInterface.h.

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


Member Data Documentation

DRTRecordedSnoutSequence* ml::DcmDRTRecordedSnoutSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 133 of file mlDcmDRTRecordedSnoutSequenceInterface.h.


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

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