MeVisLab Toolbox Reference
ml::DcmDRTRelatedRTROIObservationsSequenceInterface Class Reference

Class to provide access to DRTRelatedRTROIObservationsSequence. More...

#include <mlDcmDRTRelatedRTROIObservationsSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTRelatedRTROIObservationsSequenceInterface ()
 DcmDRTRelatedRTROIObservationsSequenceInterface (std::vector< DcmDRTRelatedRTROIObservationsSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTRelatedRTROIObservationsSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTRelatedRTROIObservationsSequenceInterface ()
 Default virtual Destructor.
bool getObservationNumber (unsigned long idx, std::string &parameter) const
bool getObservationNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getObservationNumberTag () const
bool setObservationNumber (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTRelatedRTROIObservationsSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTRelatedRTROIObservationsSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTRelatedRTROIObservationsSequenceInterface::Item getItem (const size_t idx) const
DcmDRTRelatedRTROIObservationsSequenceInterface::Item & addItem ()
void addItem (DcmDRTRelatedRTROIObservationsSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTRelatedRTROIObservationsSequence.

Definition at line 43 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRelatedRTROIObservationsSequenceInterface() [1/3]

ml::DcmDRTRelatedRTROIObservationsSequenceInterface::DcmDRTRelatedRTROIObservationsSequenceInterface ( )
inline

Definition at line 78 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

◆ DcmDRTRelatedRTROIObservationsSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 81 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ DcmDRTRelatedRTROIObservationsSequenceInterface() [3/3]

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

Definition at line 83 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTRelatedRTROIObservationsSequenceInterface()

virtual ml::DcmDRTRelatedRTROIObservationsSequenceInterface::~DcmDRTRelatedRTROIObservationsSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 91 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 134 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 139 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ getItem()

DcmDRTRelatedRTROIObservationsSequenceInterface::Item ml::DcmDRTRelatedRTROIObservationsSequenceInterface::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 125 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTRelatedRTROIObservationsSequenceInterface::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 119 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ getObservationNumber() [1/2]

bool ml::DcmDRTRelatedRTROIObservationsSequenceInterface::getObservationNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getObservationNumber() [2/2]

bool ml::DcmDRTRelatedRTROIObservationsSequenceInterface::getObservationNumber ( unsigned long idx,
std::string & parameter ) const

◆ getObservationNumberTag()

std::string ml::DcmDRTRelatedRTROIObservationsSequenceInterface::getObservationNumberTag ( ) const
inline

Definition at line 95 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

◆ getSequence()

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

Return the DRTRelatedRTROIObservationsSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRelatedRTROIObservationsSequence

Definition at line 107 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTRelatedRTROIObservationsSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 113 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTRelatedRTROIObservationsSequenceInterface::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 145 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTRelatedRTROIObservationsSequenceInterface::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 157 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

◆ setObservationNumber()

bool ml::DcmDRTRelatedRTROIObservationsSequenceInterface::setObservationNumber ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTRelatedRTROIObservationsSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRelatedRTROIObservationsSequence

Definition at line 101 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 169 of file mlDcmDRTRelatedRTROIObservationsSequenceInterface.h.

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

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