MeVisLab Toolbox Reference
ml::DcmDRTBreedRegistrationSequenceInterface Class Reference

Class to provide access to DRTBreedRegistrationSequence. More...

#include <mlDcmDRTBreedRegistrationSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTBreedRegistrationSequenceInterface ()
 DcmDRTBreedRegistrationSequenceInterface (std::vector< DcmDRTBreedRegistrationSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTBreedRegistrationSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTBreedRegistrationSequenceInterface ()
 Default virtual Destructor.
bool getBreedRegistrationNumber (unsigned long idx, std::string &parameter) const
bool getBreedRegistrationNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getBreedRegistrationNumberTag () const
bool setBreedRegistrationNumber (unsigned long idx, std::string parameter)
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)
DcmDRTBreedRegistryCodeSequenceInterface getBreedRegistryCodeSequence (unsigned long idx) const
std::string getBreedRegistryCodeSequenceTag () const
void setBreedRegistryCodeSequence (DcmDRTBreedRegistryCodeSequenceInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTBreedRegistrationSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTBreedRegistrationSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTBreedRegistrationSequenceInterface::Item getItem (const size_t idx) const
DcmDRTBreedRegistrationSequenceInterface::Item & addItem ()
void addItem (DcmDRTBreedRegistrationSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTBreedRegistrationSequence.

Definition at line 44 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTBreedRegistrationSequenceInterface() [1/3]

ml::DcmDRTBreedRegistrationSequenceInterface::DcmDRTBreedRegistrationSequenceInterface ( )
inline

Definition at line 134 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ DcmDRTBreedRegistrationSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 137 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ DcmDRTBreedRegistrationSequenceInterface() [3/3]

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

Definition at line 139 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTBreedRegistrationSequenceInterface()

virtual ml::DcmDRTBreedRegistrationSequenceInterface::~DcmDRTBreedRegistrationSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 147 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 255 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 260 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ getBreedRegistrationNumber() [1/2]

bool ml::DcmDRTBreedRegistrationSequenceInterface::getBreedRegistrationNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBreedRegistrationNumber() [2/2]

bool ml::DcmDRTBreedRegistrationSequenceInterface::getBreedRegistrationNumber ( unsigned long idx,
std::string & parameter ) const

◆ getBreedRegistrationNumberTag()

std::string ml::DcmDRTBreedRegistrationSequenceInterface::getBreedRegistrationNumberTag ( ) const
inline

Definition at line 151 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getBreedRegistryCodeSequence()

DcmDRTBreedRegistryCodeSequenceInterface ml::DcmDRTBreedRegistrationSequenceInterface::getBreedRegistryCodeSequence ( unsigned long idx) const

◆ getBreedRegistryCodeSequenceTag()

std::string ml::DcmDRTBreedRegistrationSequenceInterface::getBreedRegistryCodeSequenceTag ( ) const
inline

Definition at line 216 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getCodeMeaning() [1/2]

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

◆ getCodeMeaning() [2/2]

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

◆ getCodeMeaningTag()

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

Definition at line 157 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getCodeValue() [1/2]

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

◆ getCodeValue() [2/2]

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

◆ getCodeValueTag()

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

Definition at line 163 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getCodingSchemeDesignator() [1/2]

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

◆ getCodingSchemeDesignator() [2/2]

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

◆ getCodingSchemeDesignatorTag()

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

Definition at line 169 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getCodingSchemeVersion() [1/2]

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

◆ getCodingSchemeVersion() [2/2]

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

◆ getCodingSchemeVersionTag()

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

Definition at line 175 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getContextGroupExtensionCreatorUID() [1/2]

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

◆ getContextGroupExtensionCreatorUID() [2/2]

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

◆ getContextGroupExtensionCreatorUIDTag()

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

Definition at line 181 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getContextGroupExtensionFlag() [1/2]

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

◆ getContextGroupExtensionFlag() [2/2]

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

◆ getContextGroupExtensionFlagTag()

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

Definition at line 187 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getContextGroupLocalVersion() [1/2]

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

◆ getContextGroupLocalVersion() [2/2]

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

◆ getContextGroupLocalVersionTag()

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

Definition at line 193 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getContextGroupVersion() [1/2]

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

◆ getContextGroupVersion() [2/2]

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

◆ getContextGroupVersionTag()

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

Definition at line 199 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getContextIdentifier() [1/2]

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

◆ getContextIdentifier() [2/2]

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

◆ getContextIdentifierTag()

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

Definition at line 205 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getItem()

DcmDRTBreedRegistrationSequenceInterface::Item ml::DcmDRTBreedRegistrationSequenceInterface::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 246 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ getMappingResource() [1/2]

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

◆ getMappingResource() [2/2]

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

◆ getMappingResourceTag()

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

Definition at line 211 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTBreedRegistrationSequenceInterface::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 240 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ getSequence()

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

Return the DRTBreedRegistrationSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBreedRegistrationSequence

Definition at line 228 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTBreedRegistrationSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 234 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTBreedRegistrationSequenceInterface::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 266 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTBreedRegistrationSequenceInterface::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 278 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

◆ setBreedRegistrationNumber()

bool ml::DcmDRTBreedRegistrationSequenceInterface::setBreedRegistrationNumber ( unsigned long idx,
std::string parameter )

◆ setBreedRegistryCodeSequence()

void ml::DcmDRTBreedRegistrationSequenceInterface::setBreedRegistryCodeSequence ( DcmDRTBreedRegistryCodeSequenceInterface seq,
unsigned long idx )

◆ setCodeMeaning()

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

◆ setCodeValue()

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

◆ setCodingSchemeDesignator()

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

◆ setCodingSchemeVersion()

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

◆ setContextGroupExtensionCreatorUID()

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

◆ setContextGroupExtensionFlag()

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

◆ setContextGroupLocalVersion()

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

◆ setContextGroupVersion()

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

◆ setContextIdentifier()

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

◆ setMappingResource()

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

◆ setSequence()

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

Set the DRTBreedRegistrationSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBreedRegistrationSequence

Definition at line 222 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 290 of file mlDcmDRTBreedRegistrationSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTBreedRegistrationSequenceInterface(), DcmDRTBreedRegistrationSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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