ml::DcmDRTReferencedSetupImageSequenceInterface Class Reference

Class to provide access to DRTReferencedSetupImageSequence. More...

#include <mlDcmDRTReferencedSetupImageSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTReferencedSetupImageSequenceInterface (DRTReferencedSetupImageSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTReferencedSetupImageSequenceInterface ()
 Default virtual Destructor.
bool getReferencedFrameNumber (unsigned long idx, std::string &parameter)
bool getReferencedFrameNumber (DRTReferencedSetupImageSequence::Item &item, std::string &parameter)
std::string getReferencedFrameNumberTag () const
bool setReferencedFrameNumber (unsigned long idx, std::string &parameter)
bool getReferencedSOPClassUID (unsigned long idx, std::string &parameter)
bool getReferencedSOPClassUID (DRTReferencedSetupImageSequence::Item &item, std::string &parameter)
std::string getReferencedSOPClassUIDTag () const
bool setReferencedSOPClassUID (unsigned long idx, std::string &parameter)
bool getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter)
bool getReferencedSOPInstanceUID (DRTReferencedSetupImageSequence::Item &item, std::string &parameter)
std::string getReferencedSOPInstanceUIDTag () const
bool setReferencedSOPInstanceUID (unsigned long idx, std::string &parameter)
bool getReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter)
bool getReferencedSegmentNumber (DRTReferencedSetupImageSequence::Item &item, MLuint16 &parameter)
std::string getReferencedSegmentNumberTag () const
bool setReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter)
bool getSetupImageComment (unsigned long idx, std::string &parameter)
bool getSetupImageComment (DRTReferencedSetupImageSequence::Item &item, std::string &parameter)
std::string getSetupImageCommentTag () const
bool setSetupImageComment (unsigned long idx, std::string &parameter)
void setSequence (DRTReferencedSetupImageSequence *dcmSequence)
 Set the DRTReferencedSetupImageSequence this interface class provides access to.
DRTReferencedSetupImageSequence * getSequence () const
 Return the DRTReferencedSetupImageSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTReferencedSetupImageSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTReferencedSetupImageSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTReferencedSetupImageSequence::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

DRTReferencedSetupImageSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTReferencedSetupImageSequence.

Definition at line 42 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTReferencedSetupImageSequenceInterface::DcmDRTReferencedSetupImageSequenceInterface ( DRTReferencedSetupImageSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Member Function Documentation

DRTReferencedSetupImageSequence::Item* ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

DRTReferencedSetupImageSequence::Item* ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

MLint ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedFrameNumber ( DRTReferencedSetupImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedFrameNumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedFrameNumberTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSegmentNumber ( DRTReferencedSetupImageSequence::Item &  item,
MLuint16 &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSegmentNumber ( unsigned long  idx,
MLuint16 &  parameter 
)

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSegmentNumberTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPClassUID ( DRTReferencedSetupImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPClassUID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPClassUIDTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPInstanceUID ( DRTReferencedSetupImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPInstanceUID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPInstanceUIDTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

DRTReferencedSetupImageSequence* ml::DcmDRTReferencedSetupImageSequenceInterface::getSequence (  )  const [inline]

Return the DRTReferencedSetupImageSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedSetupImageSequence

Definition at line 89 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getSetupImageComment ( DRTReferencedSetupImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getSetupImageComment ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getSetupImageCommentTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

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

Check if the DRTReferencedSetupImageSequence is set.

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

Definition at line 95 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedFrameNumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedSegmentNumber ( unsigned long  idx,
MLuint16 &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedSOPClassUID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedSOPInstanceUID ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTReferencedSetupImageSequenceInterface::setSequence ( DRTReferencedSetupImageSequence *  dcmSequence  )  [inline]

Set the DRTReferencedSetupImageSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedSetupImageSequence

Definition at line 83 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setSetupImageComment ( unsigned long  idx,
std::string &  parameter 
)

Member Data Documentation

DRTReferencedSetupImageSequence* ml::DcmDRTReferencedSetupImageSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

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