MeVisLab Toolbox Reference
Classes | Public Member Functions | Protected Attributes | List of all members
ml::DcmDRTPatientSpeciesCodeSequenceInterface Class Reference

Class to provide access to DRTPatientSpeciesCodeSequence. More...

#include <mlDcmDRTPatientSpeciesCodeSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTPatientSpeciesCodeSequenceInterface ()
 
 DcmDRTPatientSpeciesCodeSequenceInterface (std::vector< DcmDRTPatientSpeciesCodeSequenceInterface::Item > dcmSequence)
 Default Constructor.
 
 DcmDRTPatientSpeciesCodeSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTPatientSpeciesCodeSequenceInterface ()
 Default virtual Destructor.
 
bool getCodeMeaning (unsigned long idx, std::string &parameter) const
 
bool getCodeMeaning (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getCodeMeaningTag () const
 
bool setCodeMeaning (unsigned long idx, std::string parameter)
 
bool getCodeValue (unsigned long idx, std::string &parameter) const
 
bool getCodeValue (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getCodeValueTag () const
 
bool setCodeValue (unsigned long idx, std::string parameter)
 
bool getCodingSchemeDesignator (unsigned long idx, std::string &parameter) const
 
bool getCodingSchemeDesignator (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getCodingSchemeDesignatorTag () const
 
bool setCodingSchemeDesignator (unsigned long idx, std::string parameter)
 
bool getCodingSchemeVersion (unsigned long idx, std::string &parameter) const
 
bool getCodingSchemeVersion (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getCodingSchemeVersionTag () const
 
bool setCodingSchemeVersion (unsigned long idx, std::string parameter)
 
bool getContextGroupExtensionCreatorUID (unsigned long idx, std::string &parameter) const
 
bool getContextGroupExtensionCreatorUID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getContextGroupExtensionCreatorUIDTag () const
 
bool setContextGroupExtensionCreatorUID (unsigned long idx, std::string parameter)
 
bool getContextGroupExtensionFlag (unsigned long idx, std::string &parameter) const
 
bool getContextGroupExtensionFlag (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getContextGroupExtensionFlagTag () const
 
bool setContextGroupExtensionFlag (unsigned long idx, std::string parameter)
 
bool getContextGroupLocalVersion (unsigned long idx, std::string &parameter) const
 
bool getContextGroupLocalVersion (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getContextGroupLocalVersionTag () const
 
bool setContextGroupLocalVersion (unsigned long idx, std::string parameter)
 
bool getContextGroupVersion (unsigned long idx, std::string &parameter) const
 
bool getContextGroupVersion (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getContextGroupVersionTag () const
 
bool setContextGroupVersion (unsigned long idx, std::string parameter)
 
bool getContextIdentifier (unsigned long idx, std::string &parameter) const
 
bool getContextIdentifier (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getContextIdentifierTag () const
 
bool setContextIdentifier (unsigned long idx, std::string parameter)
 
bool getMappingResource (unsigned long idx, std::string &parameter) const
 
bool getMappingResource (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getMappingResourceTag () const
 
bool setMappingResource (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTPatientSpeciesCodeSequenceInterface::Item > dcmSequence)
 Set the DRTPatientSpeciesCodeSequence this interface class provides access to.
 
std::vector< DcmDRTPatientSpeciesCodeSequenceInterface::Item > 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.
 
DcmDRTPatientSpeciesCodeSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position.
 
DcmDRTPatientSpeciesCodeSequenceInterface::Item & addItem ()
 Adds a new item to the sequence.
 
void addItem (DcmDRTPatientSpeciesCodeSequenceInterface::Item newItem)
 
bool insertItem (const size_t idx)
 Insert an item at the indicated position.
 
bool removeItem (const size_t idx)
 Removes the indicated item from the sequence.
 

Protected Attributes

std::vector< DcmDRTPatientSpeciesCodeSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.
 

Detailed Description

Class to provide access to DRTPatientSpeciesCodeSequence.

Definition at line 43 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTPatientSpeciesCodeSequenceInterface() [1/3]

ml::DcmDRTPatientSpeciesCodeSequenceInterface::DcmDRTPatientSpeciesCodeSequenceInterface ( )
inline

Definition at line 123 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

◆ DcmDRTPatientSpeciesCodeSequenceInterface() [2/3]

ml::DcmDRTPatientSpeciesCodeSequenceInterface::DcmDRTPatientSpeciesCodeSequenceInterface ( std::vector< DcmDRTPatientSpeciesCodeSequenceInterface::Item > dcmSequence)
inline

Default Constructor.

Definition at line 126 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

◆ DcmDRTPatientSpeciesCodeSequenceInterface() [3/3]

ml::DcmDRTPatientSpeciesCodeSequenceInterface::DcmDRTPatientSpeciesCodeSequenceInterface ( DCMTree::TreePtrVector treePtrSeq)
inline

Definition at line 128 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

References mlrange_cast().

◆ ~DcmDRTPatientSpeciesCodeSequenceInterface()

virtual ml::DcmDRTPatientSpeciesCodeSequenceInterface::~DcmDRTPatientSpeciesCodeSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 136 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTPatientSpeciesCodeSequenceInterface::Item & ml::DcmDRTPatientSpeciesCodeSequenceInterface::addItem ( )
inline

Adds a new item to the sequence.

Returns
Return the new item which has been added to the sequence

Definition at line 233 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

◆ addItem() [2/2]

void ml::DcmDRTPatientSpeciesCodeSequenceInterface::addItem ( DcmDRTPatientSpeciesCodeSequenceInterface::Item newItem)
inline

Definition at line 238 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

References mlrange_cast().

◆ getCodeMeaning() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodeMeaning ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCodeMeaning() [2/2]

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

◆ getCodeMeaningTag()

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

Definition at line 140 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getCodeMeaningTag().

◆ getCodeValue() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodeValue ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCodeValue() [2/2]

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

◆ getCodeValueTag()

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

Definition at line 146 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getCodeValueTag().

◆ getCodingSchemeDesignator() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodingSchemeDesignator ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCodingSchemeDesignator() [2/2]

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

◆ getCodingSchemeDesignatorTag()

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

Definition at line 152 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getCodingSchemeDesignatorTag().

◆ getCodingSchemeVersion() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getCodingSchemeVersion ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCodingSchemeVersion() [2/2]

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

◆ getCodingSchemeVersionTag()

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

Definition at line 158 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getCodingSchemeVersionTag().

◆ getContextGroupExtensionCreatorUID() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupExtensionCreatorUID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getContextGroupExtensionCreatorUID() [2/2]

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

◆ getContextGroupExtensionCreatorUIDTag()

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

Definition at line 164 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getContextGroupExtensionCreatorUIDTag().

◆ getContextGroupExtensionFlag() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupExtensionFlag ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getContextGroupExtensionFlag() [2/2]

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

◆ getContextGroupExtensionFlagTag()

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

Definition at line 170 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getContextGroupExtensionFlagTag().

◆ getContextGroupLocalVersion() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupLocalVersion ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getContextGroupLocalVersion() [2/2]

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

◆ getContextGroupLocalVersionTag()

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

Definition at line 176 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getContextGroupLocalVersionTag().

◆ getContextGroupVersion() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextGroupVersion ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getContextGroupVersion() [2/2]

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

◆ getContextGroupVersionTag()

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

Definition at line 182 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getContextGroupVersionTag().

◆ getContextIdentifier() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getContextIdentifier ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getContextIdentifier() [2/2]

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

◆ getContextIdentifierTag()

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

Definition at line 188 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getContextIdentifierTag().

◆ getItem()

DcmDRTPatientSpeciesCodeSequenceInterface::Item ml::DcmDRTPatientSpeciesCodeSequenceInterface::getItem ( const size_t idx) const
inline

Gets the item at the indicated position.

Returns
The requested item, an empty item when the position is invalid

Definition at line 224 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

References mlrange_cast().

◆ getMappingResource() [1/2]

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::getMappingResource ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getMappingResource() [2/2]

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

◆ getMappingResourceTag()

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

Definition at line 194 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceWrapper::getMappingResourceTag().

◆ getNumberOfItems()

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 218 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

◆ getSequence()

std::vector< DcmDRTPatientSpeciesCodeSequenceInterface::Item > ml::DcmDRTPatientSpeciesCodeSequenceInterface::getSequence ( ) const
inline

Return the DRTPatientSpeciesCodeSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTPatientSpeciesCodeSequence

Definition at line 206 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

Referenced by DRTPatientSpeciesCodeSequenceItemWrapper::DRTPatientSpeciesCodeSequenceItemWrapper(), and DRTPatientSpeciesCodeSequenceItemWrapper::operator=().

◆ hasSequence()

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

Check if the DRTPatientSpeciesCodeSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 212 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::insertItem ( const size_t idx)
inline

Insert an item at the indicated position.

Returns
true is the insertion was successful, false if position is invalid

Definition at line 244 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

References mlrange_cast().

◆ removeItem()

bool ml::DcmDRTPatientSpeciesCodeSequenceInterface::removeItem ( const size_t idx)
inline

Removes the indicated item from the sequence.

Returns
true if the item was deleted successfully, false if the indicated position is invalid

Definition at line 256 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

References mlrange_cast().

◆ setCodeMeaning()

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

◆ setCodeValue()

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

◆ setCodingSchemeDesignator()

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

◆ setCodingSchemeVersion()

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

◆ setContextGroupExtensionCreatorUID()

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

◆ setContextGroupExtensionFlag()

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

◆ setContextGroupLocalVersion()

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

◆ setContextGroupVersion()

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

◆ setContextIdentifier()

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

◆ setMappingResource()

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

◆ setSequence()

void ml::DcmDRTPatientSpeciesCodeSequenceInterface::setSequence ( std::vector< DcmDRTPatientSpeciesCodeSequenceInterface::Item > dcmSequence)
inline

Set the DRTPatientSpeciesCodeSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTPatientSpeciesCodeSequence

Definition at line 200 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

References mlrange_cast().

Referenced by DRTPatientSpeciesCodeSequenceWrapper::DRTPatientSpeciesCodeSequenceWrapper(), and DRTPatientSpeciesCodeSequenceWrapper::operator=().

Member Data Documentation

◆ _itemVec

std::vector<DcmDRTPatientSpeciesCodeSequenceInterface::Item> ml::DcmDRTPatientSpeciesCodeSequenceInterface::_itemVec
protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 268 of file mlDcmDRTPatientSpeciesCodeSequenceInterface.h.

The documentation for this class was generated from the following file: