MeVisLab Toolbox Reference
ml::DcmDRTReferencedFrameOfReferenceSequenceInterface Class Reference

Class to provide access to DRTReferencedFrameOfReferenceSequence. More...

#include <mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTReferencedFrameOfReferenceSequenceInterface ()
 DcmDRTReferencedFrameOfReferenceSequenceInterface (std::vector< DcmDRTReferencedFrameOfReferenceSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTReferencedFrameOfReferenceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTReferencedFrameOfReferenceSequenceInterface ()
 Default virtual Destructor.
bool getFrameOfReferenceUID (unsigned long idx, std::string &parameter) const
bool getFrameOfReferenceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string getFrameOfReferenceUIDTag () const
bool setFrameOfReferenceUID (unsigned long idx, std::string parameter)
bool getROIDescription (unsigned long idx, std::string &parameter) const
bool getROIDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string getROIDescriptionTag () const
bool setROIDescription (unsigned long idx, std::string parameter)
bool getROIGenerationAlgorithm (unsigned long idx, std::string &parameter) const
bool getROIGenerationAlgorithm (DCMTree::TreePtr item, std::string &parameter) const
std::string getROIGenerationAlgorithmTag () const
bool setROIGenerationAlgorithm (unsigned long idx, std::string parameter)
bool getROIGenerationDescription (unsigned long idx, std::string &parameter) const
bool getROIGenerationDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string getROIGenerationDescriptionTag () const
bool setROIGenerationDescription (unsigned long idx, std::string parameter)
bool getROIName (unsigned long idx, std::string &parameter) const
bool getROIName (DCMTree::TreePtr item, std::string &parameter) const
std::string getROINameTag () const
bool setROIName (unsigned long idx, std::string parameter)
bool getROINumber (unsigned long idx, std::string &parameter) const
bool getROINumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getROINumberTag () const
bool setROINumber (unsigned long idx, std::string parameter)
bool getROIVolume (unsigned long idx, std::string &parameter) const
bool getROIVolume (DCMTree::TreePtr item, std::string &parameter) const
std::string getROIVolumeTag () const
bool setROIVolume (unsigned long idx, std::string parameter)
bool getReferencedFrameOfReferenceUID (unsigned long idx, std::string &parameter) const
bool getReferencedFrameOfReferenceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedFrameOfReferenceUIDTag () const
bool setReferencedFrameOfReferenceUID (unsigned long idx, std::string parameter)
DcmDRTFrameOfReferenceRelationshipSequenceInterface getFrameOfReferenceRelationshipSequence (unsigned long idx) const
std::string getFrameOfReferenceRelationshipSequenceTag () const
void setFrameOfReferenceRelationshipSequence (DcmDRTFrameOfReferenceRelationshipSequenceInterface seq, unsigned long idx)
DcmDRTRTReferencedStudySequenceInterface getRTReferencedStudySequence (unsigned long idx) const
std::string getRTReferencedStudySequenceTag () const
void setRTReferencedStudySequence (DcmDRTRTReferencedStudySequenceInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTReferencedFrameOfReferenceSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedFrameOfReferenceSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTReferencedFrameOfReferenceSequenceInterface::Item getItem (const size_t idx) const
DcmDRTReferencedFrameOfReferenceSequenceInterface::Item & addItem ()
void addItem (DcmDRTReferencedFrameOfReferenceSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTReferencedFrameOfReferenceSequence.

Definition at line 45 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTReferencedFrameOfReferenceSequenceInterface() [1/3]

ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::DcmDRTReferencedFrameOfReferenceSequenceInterface ( )
inline

Definition at line 125 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ DcmDRTReferencedFrameOfReferenceSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 128 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ DcmDRTReferencedFrameOfReferenceSequenceInterface() [3/3]

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

Definition at line 130 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTReferencedFrameOfReferenceSequenceInterface()

virtual ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::~DcmDRTReferencedFrameOfReferenceSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 138 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTReferencedFrameOfReferenceSequenceInterface::Item & ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 238 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ getFrameOfReferenceRelationshipSequence()

DcmDRTFrameOfReferenceRelationshipSequenceInterface ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceRelationshipSequence ( unsigned long idx) const

◆ getFrameOfReferenceRelationshipSequenceTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceRelationshipSequenceTag ( ) const
inline

Definition at line 189 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getFrameOfReferenceUID() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceUID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFrameOfReferenceUID() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceUID ( unsigned long idx,
std::string & parameter ) const

◆ getFrameOfReferenceUIDTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getFrameOfReferenceUIDTag ( ) const
inline

Definition at line 142 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getItem()

DcmDRTReferencedFrameOfReferenceSequenceInterface::Item ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ getReferencedFrameOfReferenceUID() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getReferencedFrameOfReferenceUID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedFrameOfReferenceUID() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getReferencedFrameOfReferenceUID ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedFrameOfReferenceUIDTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getReferencedFrameOfReferenceUIDTag ( ) const
inline

Definition at line 184 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getROIDescription() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIDescription ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getROIDescription() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIDescription ( unsigned long idx,
std::string & parameter ) const

◆ getROIDescriptionTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIDescriptionTag ( ) const
inline

Definition at line 148 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getROIGenerationAlgorithm() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationAlgorithm ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getROIGenerationAlgorithm() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationAlgorithm ( unsigned long idx,
std::string & parameter ) const

◆ getROIGenerationAlgorithmTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationAlgorithmTag ( ) const
inline

Definition at line 154 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getROIGenerationDescription() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationDescription ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getROIGenerationDescription() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationDescription ( unsigned long idx,
std::string & parameter ) const

◆ getROIGenerationDescriptionTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIGenerationDescriptionTag ( ) const
inline

Definition at line 160 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getROIName() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getROIName() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIName ( unsigned long idx,
std::string & parameter ) const

◆ getROINameTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROINameTag ( ) const
inline

Definition at line 166 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getROINumber() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROINumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getROINumber() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROINumber ( unsigned long idx,
std::string & parameter ) const

◆ getROINumberTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROINumberTag ( ) const
inline

Definition at line 172 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getROIVolume() [1/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIVolume ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getROIVolume() [2/2]

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIVolume ( unsigned long idx,
std::string & parameter ) const

◆ getROIVolumeTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getROIVolumeTag ( ) const
inline

Definition at line 178 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getRTReferencedStudySequence()

DcmDRTRTReferencedStudySequenceInterface ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getRTReferencedStudySequence ( unsigned long idx) const

◆ getRTReferencedStudySequenceTag()

std::string ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::getRTReferencedStudySequenceTag ( ) const
inline

Definition at line 194 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

◆ getSequence()

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

Return the DRTReferencedFrameOfReferenceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedFrameOfReferenceSequence

Definition at line 206 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTReferencedFrameOfReferenceSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 212 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::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 mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

◆ setFrameOfReferenceRelationshipSequence()

void ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setFrameOfReferenceRelationshipSequence ( DcmDRTFrameOfReferenceRelationshipSequenceInterface seq,
unsigned long idx )

◆ setFrameOfReferenceUID()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setFrameOfReferenceUID ( unsigned long idx,
std::string parameter )

◆ setReferencedFrameOfReferenceUID()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setReferencedFrameOfReferenceUID ( unsigned long idx,
std::string parameter )

◆ setROIDescription()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setROIDescription ( unsigned long idx,
std::string parameter )

◆ setROIGenerationAlgorithm()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setROIGenerationAlgorithm ( unsigned long idx,
std::string parameter )

◆ setROIGenerationDescription()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setROIGenerationDescription ( unsigned long idx,
std::string parameter )

◆ setROIName()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setROIName ( unsigned long idx,
std::string parameter )

◆ setROINumber()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setROINumber ( unsigned long idx,
std::string parameter )

◆ setROIVolume()

bool ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setROIVolume ( unsigned long idx,
std::string parameter )

◆ setRTReferencedStudySequence()

void ml::DcmDRTReferencedFrameOfReferenceSequenceInterface::setRTReferencedStudySequence ( DcmDRTRTReferencedStudySequenceInterface seq,
unsigned long idx )

◆ setSequence()

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

Set the DRTReferencedFrameOfReferenceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedFrameOfReferenceSequence

Definition at line 200 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 268 of file mlDcmDRTReferencedFrameOfReferenceSequenceInterface.h.

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

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