ml::DcmDRTReferencedFrameOfReferenceSequenceInterface Class Reference

Class to provide access to DRTReferencedFrameOfReferenceSequence. More...

#include <mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTReferencedFrameOfReferenceSequenceInterface (DRTReferencedFrameOfReferenceSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTReferencedFrameOfReferenceSequenceInterface ()
 Default virtual Destructor.
bool getFrameOfReferenceUID (unsigned long idx, std::string &parameter)
bool getFrameOfReferenceUID (DRTReferencedFrameOfReferenceSequence::Item &item, std::string &parameter)
std::string getFrameOfReferenceUIDTag () const
bool setFrameOfReferenceUID (unsigned long idx, std::string &parameter)
bool getROIDescription (unsigned long idx, std::string &parameter)
bool getROIDescription (DRTReferencedFrameOfReferenceSequence::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 (DRTReferencedFrameOfReferenceSequence::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 (DRTReferencedFrameOfReferenceSequence::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 (DRTReferencedFrameOfReferenceSequence::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 (DRTReferencedFrameOfReferenceSequence::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 (DRTReferencedFrameOfReferenceSequence::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 (DRTReferencedFrameOfReferenceSequence::Item &item, std::string &parameter)
std::string getReferencedFrameOfReferenceUIDTag () const
bool setReferencedFrameOfReferenceUID (unsigned long idx, std::string &parameter)
DRTFrameOfReferenceRelationshipSequence & getFrameOfReferenceRelationshipSequence (unsigned long idx)
std::string getFrameOfReferenceRelationshipSequenceTag () const
DRTRTReferencedStudySequence & getRTReferencedStudySequence (unsigned long idx)
std::string getRTReferencedStudySequenceTag () const
void setSequence (DRTReferencedFrameOfReferenceSequence *dcmSequence)
 Set the DRTReferencedFrameOfReferenceSequence this interface class provides access to.
DRTReferencedFrameOfReferenceSequence * getSequence () const
 Return the DRTReferencedFrameOfReferenceSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTReferencedFrameOfReferenceSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTReferencedFrameOfReferenceSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTReferencedFrameOfReferenceSequence::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

DRTReferencedFrameOfReferenceSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTReferencedFrameOfReferenceSequence.

Definition at line 44 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::DcmDRTReferencedFrameOfReferenceSequenceInterface ( DRTReferencedFrameOfReferenceSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 48 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 51 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

Member Function Documentation

DRTReferencedFrameOfReferenceSequence::Item* ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 147 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

DRTFrameOfReferenceRelationshipSequence& ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceRelationshipSequence ( unsigned long  idx  ) 

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceRelationshipSequenceTag (  )  const [inline]

Definition at line 102 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceUID ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceUID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceUIDTag (  )  const [inline]

Definition at line 55 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

DRTReferencedFrameOfReferenceSequence::Item* ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 138 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

MLint ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 129 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getReferencedFrameOfReferenceUID ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 97 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIDescription ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 61 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationAlgorithm ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 67 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationDescription ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 73 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIName ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 79 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROINumber ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 85 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIVolume ( DRTReferencedFrameOfReferenceSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 91 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

DRTRTReferencedStudySequence& ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getRTReferencedStudySequence ( unsigned long  idx  ) 

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getRTReferencedStudySequenceTag (  )  const [inline]

Definition at line 106 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

DRTReferencedFrameOfReferenceSequence* ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getSequence (  )  const [inline]

Return the DRTReferencedFrameOfReferenceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedFrameOfReferenceSequence

Definition at line 117 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

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

Check if the DRTReferencedFrameOfReferenceSequence is set.

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

Definition at line 123 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 158 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 169 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setFrameOfReferenceUID ( unsigned long  idx,
std::string &  parameter 
)

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

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

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

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

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

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

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

void ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setSequence ( DRTReferencedFrameOfReferenceSequence *  dcmSequence  )  [inline]

Set the DRTReferencedFrameOfReferenceSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedFrameOfReferenceSequence

Definition at line 111 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

Member Data Documentation

DRTReferencedFrameOfReferenceSequence* ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 179 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.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