ml::DcmDRTStructureSetROISequenceInterface Class Reference

Class to provide access to DRTStructureSetROISequence. More...

#include <mlDcmDRTStructureSetROISequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTStructureSetROISequenceInterface (DRTStructureSetROISequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTStructureSetROISequenceInterface ()
 Default virtual Destructor.
bool getROIDescription (unsigned long idx, std::string &parameter)
bool getROIDescription (DRTStructureSetROISequence::Item &item, std::string &parameter)
std::string getROIDescriptionTag () const
bool setROIDescription (unsigned long idx, std::string &parameter)
bool getROIGenerationAlgorithm (unsigned long idx, std::string &parameter)
bool getROIGenerationAlgorithm (DRTStructureSetROISequence::Item &item, std::string &parameter)
std::string getROIGenerationAlgorithmTag () const
bool setROIGenerationAlgorithm (unsigned long idx, std::string &parameter)
bool getROIGenerationDescription (unsigned long idx, std::string &parameter)
bool getROIGenerationDescription (DRTStructureSetROISequence::Item &item, std::string &parameter)
std::string getROIGenerationDescriptionTag () const
bool setROIGenerationDescription (unsigned long idx, std::string &parameter)
bool getROIName (unsigned long idx, std::string &parameter)
bool getROIName (DRTStructureSetROISequence::Item &item, std::string &parameter)
std::string getROINameTag () const
bool setROIName (unsigned long idx, std::string &parameter)
bool getROINumber (unsigned long idx, std::string &parameter)
bool getROINumber (DRTStructureSetROISequence::Item &item, std::string &parameter)
std::string getROINumberTag () const
bool setROINumber (unsigned long idx, std::string &parameter)
bool getROIVolume (unsigned long idx, std::string &parameter)
bool getROIVolume (DRTStructureSetROISequence::Item &item, std::string &parameter)
std::string getROIVolumeTag () const
bool setROIVolume (unsigned long idx, std::string &parameter)
bool getReferencedFrameOfReferenceUID (unsigned long idx, std::string &parameter)
bool getReferencedFrameOfReferenceUID (DRTStructureSetROISequence::Item &item, std::string &parameter)
std::string getReferencedFrameOfReferenceUIDTag () const
bool setReferencedFrameOfReferenceUID (unsigned long idx, std::string &parameter)
void setSequence (DRTStructureSetROISequence *dcmSequence)
 Set the DRTStructureSetROISequence this interface class provides access to.
DRTStructureSetROISequence * getSequence () const
 Return the DRTStructureSetROISequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTStructureSetROISequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTStructureSetROISequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTStructureSetROISequence::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

DRTStructureSetROISequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTStructureSetROISequence.

Definition at line 42 of file mlDcmDRTStructureSetROISequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTStructureSetROISequenceInterface::DcmDRTStructureSetROISequenceInterface ( DRTStructureSetROISequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTStructureSetROISequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTStructureSetROISequenceInterface.h.

Member Function Documentation

DRTStructureSetROISequence::Item* ml::DcmDRTStructureSetROISequenceInterface::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 131 of file mlDcmDRTStructureSetROISequenceInterface.h.

DRTStructureSetROISequence::Item* ml::DcmDRTStructureSetROISequenceInterface::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 122 of file mlDcmDRTStructureSetROISequenceInterface.h.

MLint ml::DcmDRTStructureSetROISequenceInterface::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 113 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::getReferencedFrameOfReferenceUID ( DRTStructureSetROISequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::getReferencedFrameOfReferenceUID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTStructureSetROISequenceInterface::getReferencedFrameOfReferenceUIDTag (  )  const [inline]

Definition at line 89 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::getROIDescription ( DRTStructureSetROISequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::getROIDescription ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTStructureSetROISequenceInterface::getROIDescriptionTag (  )  const [inline]

Definition at line 53 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::getROIGenerationAlgorithm ( DRTStructureSetROISequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::getROIGenerationAlgorithm ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTStructureSetROISequenceInterface::getROIGenerationAlgorithmTag (  )  const [inline]

Definition at line 59 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::getROIGenerationDescription ( DRTStructureSetROISequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::getROIGenerationDescription ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTStructureSetROISequenceInterface::getROIGenerationDescriptionTag (  )  const [inline]

Definition at line 65 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::getROIName ( DRTStructureSetROISequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::getROIName ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTStructureSetROISequenceInterface::getROINameTag (  )  const [inline]

Definition at line 71 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::getROINumber ( DRTStructureSetROISequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::getROINumber ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTStructureSetROISequenceInterface::getROINumberTag (  )  const [inline]

Definition at line 77 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::getROIVolume ( DRTStructureSetROISequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::getROIVolume ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTStructureSetROISequenceInterface::getROIVolumeTag (  )  const [inline]

Definition at line 83 of file mlDcmDRTStructureSetROISequenceInterface.h.

DRTStructureSetROISequence* ml::DcmDRTStructureSetROISequenceInterface::getSequence (  )  const [inline]

Return the DRTStructureSetROISequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTStructureSetROISequence

Definition at line 101 of file mlDcmDRTStructureSetROISequenceInterface.h.

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

Check if the DRTStructureSetROISequence is set.

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

Definition at line 107 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::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 142 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::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 153 of file mlDcmDRTStructureSetROISequenceInterface.h.

bool ml::DcmDRTStructureSetROISequenceInterface::setReferencedFrameOfReferenceUID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::setROIDescription ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::setROIGenerationAlgorithm ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::setROIGenerationDescription ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::setROIName ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::setROINumber ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTStructureSetROISequenceInterface::setROIVolume ( unsigned long  idx,
std::string &  parameter 
)

void ml::DcmDRTStructureSetROISequenceInterface::setSequence ( DRTStructureSetROISequence *  dcmSequence  )  [inline]

Set the DRTStructureSetROISequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTStructureSetROISequence

Definition at line 95 of file mlDcmDRTStructureSetROISequenceInterface.h.

Member Data Documentation

DRTStructureSetROISequence* ml::DcmDRTStructureSetROISequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 163 of file mlDcmDRTStructureSetROISequenceInterface.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