MeVisLab Toolbox Reference
ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface Class Reference

Class to provide access to DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule. More...

#include <mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h>

Classes

class  Item

Public Member Functions

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

Protected Attributes

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

Detailed Description

Class to provide access to DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule.

Definition at line 43 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface() [1/3]

ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface ( )
inline

Definition at line 78 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

◆ DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface() [2/3]

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

Default Constructor.

Definition at line 81 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface() [3/3]

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

Definition at line 83 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ ~DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface()

virtual ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::~DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 91 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::Item & ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 139 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ getItem()

DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::Item ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ getReferencedBrachyApplicationSetupNumber() [1/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::getReferencedBrachyApplicationSetupNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedBrachyApplicationSetupNumber() [2/2]

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::getReferencedBrachyApplicationSetupNumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedBrachyApplicationSetupNumberTag()

std::string ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::getReferencedBrachyApplicationSetupNumberTag ( ) const
inline

Definition at line 95 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

◆ getSequence()

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

Return the DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule

Definition at line 107 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 113 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::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 mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

◆ setReferencedBrachyApplicationSetupNumber()

bool ml::DcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface::setReferencedBrachyApplicationSetupNumber ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedBrachyApplicationSetupSequenceInRTDoseModule

Definition at line 101 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 169 of file mlDcmDRTReferencedBrachyApplicationSetupSequenceInRTDoseModuleInterface.h.

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

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