ml::DcmDRTRTReferencedSeriesSequenceInterface Class Reference

Class to provide access to DRTRTReferencedSeriesSequence. More...

#include <mlDcmDRTRTReferencedSeriesSequenceInterface.h>

List of all members.

Public Member Functions

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

DRTRTReferencedSeriesSequence * _dcmSequence
 Reference to the wrapped DcmSequence.


Detailed Description

Class to provide access to DRTRTReferencedSeriesSequence.

Definition at line 43 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.


Constructor & Destructor Documentation

ml::DcmDRTRTReferencedSeriesSequenceInterface::DcmDRTRTReferencedSeriesSequenceInterface ( DRTRTReferencedSeriesSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.


Member Function Documentation

DRTRTReferencedSeriesSequence::Item* ml::DcmDRTRTReferencedSeriesSequenceInterface::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 100 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

DRTContourImageSequence& ml::DcmDRTRTReferencedSeriesSequenceInterface::getContourImageSequence ( unsigned long  idx  ) 

std::string ml::DcmDRTRTReferencedSeriesSequenceInterface::getContourImageSequenceTag (  )  const [inline]

DRTRTReferencedSeriesSequence::Item* ml::DcmDRTRTReferencedSeriesSequenceInterface::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 91 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

MLint ml::DcmDRTRTReferencedSeriesSequenceInterface::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 82 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

DRTRTReferencedSeriesSequence* ml::DcmDRTRTReferencedSeriesSequenceInterface::getSequence (  )  const [inline]

Return the DRTRTReferencedSeriesSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRTReferencedSeriesSequence

Definition at line 70 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::getSeriesInstanceUID ( DRTRTReferencedSeriesSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::getSeriesInstanceUID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTRTReferencedSeriesSequenceInterface::getSeriesInstanceUIDTag (  )  const [inline]

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

Check if the DRTRTReferencedSeriesSequence is set.

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

Definition at line 76 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::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 111 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::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 122 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

void ml::DcmDRTRTReferencedSeriesSequenceInterface::setSequence ( DRTRTReferencedSeriesSequence *  dcmSequence  )  [inline]

Set the DRTRTReferencedSeriesSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTRTReferencedSeriesSequence

Definition at line 64 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::setSeriesInstanceUID ( unsigned long  idx,
std::string &  parameter 
)


Member Data Documentation

DRTRTReferencedSeriesSequence* ml::DcmDRTRTReferencedSeriesSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 132 of file mlDcmDRTRTReferencedSeriesSequenceInterface.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