ml::DcmDRTPatientSpeciesCodeSequenceInterface Class Reference

Class to provide access to DRTPatientSpeciesCodeSequence. More...

#include <mlDcmDRTPatientSpeciesCodeSequenceInterface.h>

List of all members.

Public Member Functions

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

DRTPatientSpeciesCodeSequence * _dcmSequence
 Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTPatientSpeciesCodeSequence.

Definition at line 42 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTPatientSpeciesCodeSequenceInterface::DcmDRTPatientSpeciesCodeSequenceInterface ( DRTPatientSpeciesCodeSequence *  _dcmSequence = NULL  )  [inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

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

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Member Function Documentation

DRTPatientSpeciesCodeSequence::Item* ml::DcmDRTPatientSpeciesCodeSequenceInterface::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 149 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodeMeaning ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 53 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodeValue ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 59 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodingSchemeDesignator ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 65 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodingSchemeVersion ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 71 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupExtensionCreatorUID ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 77 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupExtensionFlag ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 83 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupLocalVersion ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 89 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupVersion ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 95 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextIdentifier ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 101 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

DRTPatientSpeciesCodeSequence::Item* ml::DcmDRTPatientSpeciesCodeSequenceInterface::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 140 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getMappingResource ( DRTPatientSpeciesCodeSequence::Item &  item,
std::string &  parameter 
)

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

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

Definition at line 107 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

MLint ml::DcmDRTPatientSpeciesCodeSequenceInterface::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 131 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

DRTPatientSpeciesCodeSequence* ml::DcmDRTPatientSpeciesCodeSequenceInterface::getSequence (  )  const [inline]

Return the DRTPatientSpeciesCodeSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTPatientSpeciesCodeSequence

Definition at line 119 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

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

Check if the DRTPatientSpeciesCodeSequence is set.

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

Definition at line 125 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::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 160 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::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 171 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

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

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

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

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

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

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

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

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

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

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

void ml::DcmDRTPatientSpeciesCodeSequenceInterface::setSequence ( DRTPatientSpeciesCodeSequence *  dcmSequence  )  [inline]

Set the DRTPatientSpeciesCodeSequence this interface class provides access to.

Parameters:
dcmSequence Pointer to DRTPatientSpeciesCodeSequence

Definition at line 113 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Member Data Documentation

DRTPatientSpeciesCodeSequence* ml::DcmDRTPatientSpeciesCodeSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 181 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

The documentation for this class was generated from the following file:
Generated on Sat Sep 3 18:39:46 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8