MeVisLab Toolbox Reference
ml::DcmDRTReferencedImageSequenceInterface Class Reference

Class to provide access to DRTReferencedImageSequence. More...

#include <mlDcmDRTReferencedImageSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTReferencedImageSequenceInterface ()
 
 DcmDRTReferencedImageSequenceInterface (std::vector< DcmDRTReferencedImageSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTReferencedImageSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTReferencedImageSequenceInterface ()
 Default virtual Destructor. More...
 
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)
 
bool getReferencedFrameNumber (unsigned long idx, std::string &parameter) const
 
bool getReferencedFrameNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getReferencedFrameNumberTag () const
 
bool setReferencedFrameNumber (unsigned long idx, std::string parameter)
 
bool getReferencedSOPClassUID (unsigned long idx, std::string &parameter) const
 
bool getReferencedSOPClassUID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getReferencedSOPClassUIDTag () const
 
bool setReferencedSOPClassUID (unsigned long idx, std::string parameter)
 
bool getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter) const
 
bool getReferencedSOPInstanceUID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getReferencedSOPInstanceUIDTag () const
 
bool setReferencedSOPInstanceUID (unsigned long idx, std::string parameter)
 
bool getReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter) const
 
bool getReferencedSegmentNumber (DCMTree::TreePtr item, MLuint16 &parameter) const
 
std::string getReferencedSegmentNumberTag () const
 
bool setReferencedSegmentNumber (unsigned long idx, MLuint16 parameter)
 
DcmDRTPurposeOfReferenceCodeSequenceInterface getPurposeOfReferenceCodeSequence (unsigned long idx) const
 
std::string getPurposeOfReferenceCodeSequenceTag () const
 
void setPurposeOfReferenceCodeSequence (DcmDRTPurposeOfReferenceCodeSequenceInterface seq, unsigned long idx)
 
void setSequence (std::vector< DcmDRTReferencedImageSequenceInterface::Item > dcmSequence)
 Set the DRTReferencedImageSequence this interface class provides access to. More...
 
std::vector< DcmDRTReferencedImageSequenceInterface::ItemgetSequence () const
 Return the DRTReferencedImageSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTReferencedImageSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTReferencedImageSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTReferencedImageSequenceInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTReferencedImageSequenceInterface::Item newItem)
 
bool insertItem (const size_t idx)
 Insert an item at the indicated position. More...
 
bool removeItem (const size_t idx)
 Removes the indicated item from the sequence. More...
 

Protected Attributes

std::vector< DcmDRTReferencedImageSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTReferencedImageSequence.

Definition at line 44 of file mlDcmDRTReferencedImageSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTReferencedImageSequenceInterface() [1/3]

ml::DcmDRTReferencedImageSequenceInterface::DcmDRTReferencedImageSequenceInterface ( )
inline

Definition at line 149 of file mlDcmDRTReferencedImageSequenceInterface.h.

◆ DcmDRTReferencedImageSequenceInterface() [2/3]

ml::DcmDRTReferencedImageSequenceInterface::DcmDRTReferencedImageSequenceInterface ( std::vector< DcmDRTReferencedImageSequenceInterface::Item dcmSequence)
inline

Default Constructor.

Definition at line 152 of file mlDcmDRTReferencedImageSequenceInterface.h.

◆ DcmDRTReferencedImageSequenceInterface() [3/3]

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

Definition at line 154 of file mlDcmDRTReferencedImageSequenceInterface.h.

◆ ~DcmDRTReferencedImageSequenceInterface()

virtual ml::DcmDRTReferencedImageSequenceInterface::~DcmDRTReferencedImageSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 162 of file mlDcmDRTReferencedImageSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 288 of file mlDcmDRTReferencedImageSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 293 of file mlDcmDRTReferencedImageSequenceInterface.h.

◆ getCodeMeaning() [1/2]

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

◆ getCodeMeaning() [2/2]

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

◆ getCodeMeaningTag()

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

◆ getCodeValue() [1/2]

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

◆ getCodeValue() [2/2]

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

◆ getCodeValueTag()

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

◆ getCodingSchemeDesignator() [1/2]

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

◆ getCodingSchemeDesignator() [2/2]

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

◆ getCodingSchemeDesignatorTag()

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

◆ getCodingSchemeVersion() [1/2]

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

◆ getCodingSchemeVersion() [2/2]

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

◆ getCodingSchemeVersionTag()

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

◆ getContextGroupExtensionCreatorUID() [1/2]

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

◆ getContextGroupExtensionCreatorUID() [2/2]

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

◆ getContextGroupExtensionCreatorUIDTag()

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

◆ getContextGroupExtensionFlag() [1/2]

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

◆ getContextGroupExtensionFlag() [2/2]

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

◆ getContextGroupExtensionFlagTag()

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

◆ getContextGroupLocalVersion() [1/2]

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

◆ getContextGroupLocalVersion() [2/2]

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

◆ getContextGroupLocalVersionTag()

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

◆ getContextGroupVersion() [1/2]

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

◆ getContextGroupVersion() [2/2]

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

◆ getContextGroupVersionTag()

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

◆ getContextIdentifier() [1/2]

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

◆ getContextIdentifier() [2/2]

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

◆ getContextIdentifierTag()

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

◆ getItem()

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

◆ getMappingResource() [1/2]

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

◆ getMappingResource() [2/2]

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

◆ getMappingResourceTag()

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

◆ getNumberOfItems()

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 273 of file mlDcmDRTReferencedImageSequenceInterface.h.

◆ getPurposeOfReferenceCodeSequence()

DcmDRTPurposeOfReferenceCodeSequenceInterface ml::DcmDRTReferencedImageSequenceInterface::getPurposeOfReferenceCodeSequence ( unsigned long  idx) const

◆ getPurposeOfReferenceCodeSequenceTag()

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

◆ getReferencedFrameNumber() [1/2]

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedFrameNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getReferencedFrameNumber() [2/2]

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

◆ getReferencedFrameNumberTag()

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

◆ getReferencedSegmentNumber() [1/2]

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedSegmentNumber ( DCMTree::TreePtr  item,
MLuint16 parameter 
) const

◆ getReferencedSegmentNumber() [2/2]

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

◆ getReferencedSegmentNumberTag()

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

◆ getReferencedSOPClassUID() [1/2]

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedSOPClassUID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getReferencedSOPClassUID() [2/2]

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

◆ getReferencedSOPClassUIDTag()

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

◆ getReferencedSOPInstanceUID() [1/2]

bool ml::DcmDRTReferencedImageSequenceInterface::getReferencedSOPInstanceUID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getReferencedSOPInstanceUID() [2/2]

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

◆ getReferencedSOPInstanceUIDTag()

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

◆ getSequence()

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

Return the DRTReferencedImageSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedImageSequence

Definition at line 261 of file mlDcmDRTReferencedImageSequenceInterface.h.

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

◆ hasSequence()

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

Check if the DRTReferencedImageSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 267 of file mlDcmDRTReferencedImageSequenceInterface.h.

◆ insertItem()

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

◆ removeItem()

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

◆ setCodeMeaning()

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

◆ setCodeValue()

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

◆ setCodingSchemeDesignator()

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

◆ setCodingSchemeVersion()

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

◆ setContextGroupExtensionCreatorUID()

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

◆ setContextGroupExtensionFlag()

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

◆ setContextGroupLocalVersion()

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

◆ setContextGroupVersion()

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

◆ setContextIdentifier()

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

◆ setMappingResource()

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

◆ setPurposeOfReferenceCodeSequence()

void ml::DcmDRTReferencedImageSequenceInterface::setPurposeOfReferenceCodeSequence ( DcmDRTPurposeOfReferenceCodeSequenceInterface  seq,
unsigned long  idx 
)

◆ setReferencedFrameNumber()

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

◆ setReferencedSegmentNumber()

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

◆ setReferencedSOPClassUID()

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

◆ setReferencedSOPInstanceUID()

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

◆ setSequence()

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

Set the DRTReferencedImageSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedImageSequence

Definition at line 255 of file mlDcmDRTReferencedImageSequenceInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 323 of file mlDcmDRTReferencedImageSequenceInterface.h.


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