MeVisLab Toolbox Reference
ml::DcmDRTDVHReferencedROISequenceInterface Class Reference

Class to provide access to DRTDVHReferencedROISequence. More...

#include <mlDcmDRTDVHReferencedROISequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTDVHReferencedROISequenceInterface ()
 DcmDRTDVHReferencedROISequenceInterface (std::vector< DcmDRTDVHReferencedROISequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTDVHReferencedROISequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTDVHReferencedROISequenceInterface ()
 Default virtual Destructor.
bool getDVHROIContributionType (unsigned long idx, std::string &parameter) const
bool getDVHROIContributionType (DCMTree::TreePtr item, std::string &parameter) const
std::string getDVHROIContributionTypeTag () const
bool setDVHROIContributionType (unsigned long idx, std::string parameter)
bool getReferencedROINumber (unsigned long idx, std::string &parameter) const
bool getReferencedROINumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedROINumberTag () const
bool setReferencedROINumber (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTDVHReferencedROISequenceInterface::Item > dcmSequence)
std::vector< DcmDRTDVHReferencedROISequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTDVHReferencedROISequenceInterface::Item getItem (const size_t idx) const
DcmDRTDVHReferencedROISequenceInterface::Item & addItem ()
void addItem (DcmDRTDVHReferencedROISequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTDVHReferencedROISequence.

Definition at line 43 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTDVHReferencedROISequenceInterface() [1/3]

ml::DcmDRTDVHReferencedROISequenceInterface::DcmDRTDVHReferencedROISequenceInterface ( )
inline

Definition at line 83 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

◆ DcmDRTDVHReferencedROISequenceInterface() [2/3]

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

Default Constructor.

Definition at line 86 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ DcmDRTDVHReferencedROISequenceInterface() [3/3]

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

Definition at line 88 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ ~DcmDRTDVHReferencedROISequenceInterface()

virtual ml::DcmDRTDVHReferencedROISequenceInterface::~DcmDRTDVHReferencedROISequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 145 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 150 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ getDVHROIContributionType() [1/2]

bool ml::DcmDRTDVHReferencedROISequenceInterface::getDVHROIContributionType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getDVHROIContributionType() [2/2]

bool ml::DcmDRTDVHReferencedROISequenceInterface::getDVHROIContributionType ( unsigned long idx,
std::string & parameter ) const

◆ getDVHROIContributionTypeTag()

std::string ml::DcmDRTDVHReferencedROISequenceInterface::getDVHROIContributionTypeTag ( ) const
inline

Definition at line 100 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

◆ getItem()

DcmDRTDVHReferencedROISequenceInterface::Item ml::DcmDRTDVHReferencedROISequenceInterface::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 136 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTDVHReferencedROISequenceInterface::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 130 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ getReferencedROINumber() [1/2]

bool ml::DcmDRTDVHReferencedROISequenceInterface::getReferencedROINumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedROINumber() [2/2]

bool ml::DcmDRTDVHReferencedROISequenceInterface::getReferencedROINumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedROINumberTag()

std::string ml::DcmDRTDVHReferencedROISequenceInterface::getReferencedROINumberTag ( ) const
inline

Definition at line 106 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

◆ getSequence()

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

Return the DRTDVHReferencedROISequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTDVHReferencedROISequence

Definition at line 118 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTDVHReferencedROISequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTDVHReferencedROISequenceInterface::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 156 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTDVHReferencedROISequenceInterface::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 168 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

◆ setDVHROIContributionType()

bool ml::DcmDRTDVHReferencedROISequenceInterface::setDVHROIContributionType ( unsigned long idx,
std::string parameter )

◆ setReferencedROINumber()

bool ml::DcmDRTDVHReferencedROISequenceInterface::setReferencedROINumber ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTDVHReferencedROISequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTDVHReferencedROISequence

Definition at line 112 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTDVHReferencedROISequenceInterface.h.

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

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