ml::DcmDRTReferencedImageSequenceInterface Class Reference

Class to provide access to DRTReferencedImageSequence. More...

#include <mlDcmDRTReferencedImageSequenceInterface.h>

List of all members.

Public Member Functions

 DcmDRTReferencedImageSequenceInterface (DRTReferencedImageSequence *_dcmSequence=NULL)
 Default Constructor.
virtual ~DcmDRTReferencedImageSequenceInterface ()
 Default virtual Destructor.
bool getCodeMeaning (unsigned long idx, std::string &parameter)
bool getCodeMeaning (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getCodeMeaningTag () const
bool setCodeMeaning (unsigned long idx, std::string &parameter)
bool getCodeValue (unsigned long idx, std::string &parameter)
bool getCodeValue (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getCodeValueTag () const
bool setCodeValue (unsigned long idx, std::string &parameter)
bool getCodingSchemeDesignator (unsigned long idx, std::string &parameter)
bool getCodingSchemeDesignator (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getCodingSchemeDesignatorTag () const
bool setCodingSchemeDesignator (unsigned long idx, std::string &parameter)
bool getCodingSchemeVersion (unsigned long idx, std::string &parameter)
bool getCodingSchemeVersion (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getCodingSchemeVersionTag () const
bool setCodingSchemeVersion (unsigned long idx, std::string &parameter)
bool getContextGroupExtensionCreatorUID (unsigned long idx, std::string &parameter)
bool getContextGroupExtensionCreatorUID (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getContextGroupExtensionCreatorUIDTag () const
bool setContextGroupExtensionCreatorUID (unsigned long idx, std::string &parameter)
bool getContextGroupExtensionFlag (unsigned long idx, std::string &parameter)
bool getContextGroupExtensionFlag (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getContextGroupExtensionFlagTag () const
bool setContextGroupExtensionFlag (unsigned long idx, std::string &parameter)
bool getContextGroupLocalVersion (unsigned long idx, std::string &parameter)
bool getContextGroupLocalVersion (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getContextGroupLocalVersionTag () const
bool setContextGroupLocalVersion (unsigned long idx, std::string &parameter)
bool getContextGroupVersion (unsigned long idx, std::string &parameter)
bool getContextGroupVersion (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getContextGroupVersionTag () const
bool setContextGroupVersion (unsigned long idx, std::string &parameter)
bool getContextIdentifier (unsigned long idx, std::string &parameter)
bool getContextIdentifier (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getContextIdentifierTag () const
bool setContextIdentifier (unsigned long idx, std::string &parameter)
bool getMappingResource (unsigned long idx, std::string &parameter)
bool getMappingResource (DRTReferencedImageSequence::Item &item, std::string &parameter)
std::string getMappingResourceTag () const
bool setMappingResource (unsigned long idx, std::string &parameter)
bool getReferencedFrameNumber (unsigned long idx, std::string &parameter)
bool getReferencedFrameNumber (DRTReferencedImageSequence::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 (DRTReferencedImageSequence::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 (DRTReferencedImageSequence::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 (DRTReferencedImageSequence::Item &item, MLuint16 &parameter)
std::string getReferencedSegmentNumberTag () const
bool setReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter)
DRTPurposeOfReferenceCodeSequence & getPurposeOfReferenceCodeSequence (unsigned long idx)
std::string getPurposeOfReferenceCodeSequenceTag () const
void setSequence (DRTReferencedImageSequence *dcmSequence)
 Set the DRTReferencedImageSequence this interface class provides access to.
DRTReferencedImageSequence * getSequence () const
 Return the DRTReferencedImageSequence this interface class provides access to.
bool hasSequence () const
 Check if the DRTReferencedImageSequence is set.
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
DRTReferencedImageSequence::Item * getItem (const unsigned long idx)
 Return number of items the internal sequence consists of.
DRTReferencedImageSequence::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

DRTReferencedImageSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTReferencedImageSequence.

Definition at line 43 of file mlDcmDRTReferencedImageSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTReferencedImageSequenceInterface::DcmDRTReferencedImageSequenceInterface ( DRTReferencedImageSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTReferencedImageSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTReferencedImageSequenceInterface.h.

Member Function Documentation

DRTReferencedImageSequence::Item* ml::DcmDRTReferencedImageSequenceInterface::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 178 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getCodeMeaning ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getCodeMeaning ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getCodeMeaningTag (  )  const [inline]

Definition at line 54 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getCodeValue ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getCodeValue ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getCodeValueTag (  )  const [inline]

Definition at line 60 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getCodingSchemeDesignator ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getCodingSchemeDesignator ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getCodingSchemeDesignatorTag (  )  const [inline]

Definition at line 66 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getCodingSchemeVersion ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getCodingSchemeVersion ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getCodingSchemeVersionTag (  )  const [inline]

Definition at line 72 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupExtensionCreatorUID ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupExtensionCreatorUID ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getContextGroupExtensionCreatorUIDTag (  )  const [inline]

Definition at line 78 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupExtensionFlag ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupExtensionFlag ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getContextGroupExtensionFlagTag (  )  const [inline]

Definition at line 84 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupLocalVersion ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupLocalVersion ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getContextGroupLocalVersionTag (  )  const [inline]

Definition at line 90 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupVersion ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getContextGroupVersion ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getContextGroupVersionTag (  )  const [inline]

Definition at line 96 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getContextIdentifier ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getContextIdentifier ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getContextIdentifierTag (  )  const [inline]

Definition at line 102 of file mlDcmDRTReferencedImageSequenceInterface.h.

DRTReferencedImageSequence::Item* ml::DcmDRTReferencedImageSequenceInterface::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 169 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getMappingResource ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::getMappingResource ( unsigned long  idx,
std::string &  parameter 
)

std::string ml::DcmDRTReferencedImageSequenceInterface::getMappingResourceTag (  )  const [inline]

Definition at line 108 of file mlDcmDRTReferencedImageSequenceInterface.h.

MLint ml::DcmDRTReferencedImageSequenceInterface::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 160 of file mlDcmDRTReferencedImageSequenceInterface.h.

DRTPurposeOfReferenceCodeSequence& ml::DcmDRTReferencedImageSequenceInterface::getPurposeOfReferenceCodeSequence ( unsigned long  idx  ) 

std::string ml::DcmDRTReferencedImageSequenceInterface::getPurposeOfReferenceCodeSequenceTag (  )  const [inline]

Definition at line 137 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedFrameNumber ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 114 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedSegmentNumber ( DRTReferencedImageSequence::Item &  item,
MLuint16 &  parameter 
)

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

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

Definition at line 132 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedSOPClassUID ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 120 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedSOPInstanceUID ( DRTReferencedImageSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 126 of file mlDcmDRTReferencedImageSequenceInterface.h.

DRTReferencedImageSequence* ml::DcmDRTReferencedImageSequenceInterface::getSequence (  )  const [inline]

Return the DRTReferencedImageSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedImageSequence

Definition at line 148 of file mlDcmDRTReferencedImageSequenceInterface.h.

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

Check if the DRTReferencedImageSequence is set.

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

Definition at line 154 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::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 189 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::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 200 of file mlDcmDRTReferencedImageSequenceInterface.h.

bool ml::DcmDRTReferencedImageSequenceInterface::setCodeMeaning ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setCodeValue ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setCodingSchemeDesignator ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setCodingSchemeVersion ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setContextGroupExtensionCreatorUID ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setContextGroupExtensionFlag ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setContextGroupLocalVersion ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setContextGroupVersion ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setContextIdentifier ( unsigned long  idx,
std::string &  parameter 
)

bool ml::DcmDRTReferencedImageSequenceInterface::setMappingResource ( unsigned long  idx,
std::string &  parameter 
)

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

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

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

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

void ml::DcmDRTReferencedImageSequenceInterface::setSequence ( DRTReferencedImageSequence *  dcmSequence  )  [inline]

Set the DRTReferencedImageSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTReferencedImageSequence

Definition at line 142 of file mlDcmDRTReferencedImageSequenceInterface.h.

Member Data Documentation

DRTReferencedImageSequence* ml::DcmDRTReferencedImageSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 210 of file mlDcmDRTReferencedImageSequenceInterface.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