MeVisLab Toolbox Reference
ml::DcmDRTStructureSetROISequenceInterface Class Reference

Class to provide access to DRTStructureSetROISequence. More...

#include <mlDcmDRTStructureSetROISequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTStructureSetROISequenceInterface ()
 DcmDRTStructureSetROISequenceInterface (std::vector< DcmDRTStructureSetROISequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTStructureSetROISequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTStructureSetROISequenceInterface ()
 Default virtual Destructor.
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)
void setSequence (std::vector< DcmDRTStructureSetROISequenceInterface::Item > dcmSequence)
std::vector< DcmDRTStructureSetROISequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTStructureSetROISequenceInterface::Item getItem (const size_t idx) const
DcmDRTStructureSetROISequenceInterface::Item & addItem ()
void addItem (DcmDRTStructureSetROISequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTStructureSetROISequence.

Definition at line 43 of file mlDcmDRTStructureSetROISequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTStructureSetROISequenceInterface() [1/3]

ml::DcmDRTStructureSetROISequenceInterface::DcmDRTStructureSetROISequenceInterface ( )
inline

Definition at line 108 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ DcmDRTStructureSetROISequenceInterface() [2/3]

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

Default Constructor.

Definition at line 111 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ DcmDRTStructureSetROISequenceInterface() [3/3]

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

Definition at line 113 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ ~DcmDRTStructureSetROISequenceInterface()

virtual ml::DcmDRTStructureSetROISequenceInterface::~DcmDRTStructureSetROISequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTStructureSetROISequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 200 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 205 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ getItem()

DcmDRTStructureSetROISequenceInterface::Item ml::DcmDRTStructureSetROISequenceInterface::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 191 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTStructureSetROISequenceInterface::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 185 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ getReferencedFrameOfReferenceUID() [1/2]

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

◆ getReferencedFrameOfReferenceUID() [2/2]

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

◆ getReferencedFrameOfReferenceUIDTag()

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

Definition at line 161 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ getROIDescription() [1/2]

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

◆ getROIDescription() [2/2]

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

◆ getROIDescriptionTag()

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

Definition at line 125 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ getROIGenerationAlgorithm() [1/2]

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

◆ getROIGenerationAlgorithm() [2/2]

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

◆ getROIGenerationAlgorithmTag()

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

Definition at line 131 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ getROIGenerationDescription() [1/2]

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

◆ getROIGenerationDescription() [2/2]

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

◆ getROIGenerationDescriptionTag()

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

Definition at line 137 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ getROIName() [1/2]

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

◆ getROIName() [2/2]

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

◆ getROINameTag()

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

Definition at line 143 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ getROINumber() [1/2]

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

◆ getROINumber() [2/2]

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

◆ getROINumberTag()

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

Definition at line 149 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ getROIVolume() [1/2]

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

◆ getROIVolume() [2/2]

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

◆ getROIVolumeTag()

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

Definition at line 155 of file mlDcmDRTStructureSetROISequenceInterface.h.

◆ getSequence()

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

Return the DRTStructureSetROISequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTStructureSetROISequence

Definition at line 173 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTStructureSetROISequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTStructureSetROISequenceInterface::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 211 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTStructureSetROISequenceInterface::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 223 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

◆ setReferencedFrameOfReferenceUID()

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

◆ setROIDescription()

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

◆ setROIGenerationAlgorithm()

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

◆ setROIGenerationDescription()

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

◆ setROIName()

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

◆ setROINumber()

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

◆ setROIVolume()

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

◆ setSequence()

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

Set the DRTStructureSetROISequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTStructureSetROISequence

Definition at line 167 of file mlDcmDRTStructureSetROISequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTStructureSetROISequenceInterface.h.

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

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