MeVisLab Toolbox Reference
Classes | Public Member Functions | Protected Attributes | List of all members
ml::DcmDRTBrachyAccessoryDeviceSequenceInterface Class Reference

Class to provide access to DRTBrachyAccessoryDeviceSequence. More...

#include <mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTBrachyAccessoryDeviceSequenceInterface ()
 
 DcmDRTBrachyAccessoryDeviceSequenceInterface (std::vector< DcmDRTBrachyAccessoryDeviceSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTBrachyAccessoryDeviceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTBrachyAccessoryDeviceSequenceInterface ()
 Default virtual Destructor. More...
 
bool getBrachyAccessoryDeviceID (unsigned long idx, std::string &parameter) const
 
bool getBrachyAccessoryDeviceID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBrachyAccessoryDeviceIDTag () const
 
bool setBrachyAccessoryDeviceID (unsigned long idx, std::string parameter)
 
bool getBrachyAccessoryDeviceName (unsigned long idx, std::string &parameter) const
 
bool getBrachyAccessoryDeviceName (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBrachyAccessoryDeviceNameTag () const
 
bool setBrachyAccessoryDeviceName (unsigned long idx, std::string parameter)
 
bool getBrachyAccessoryDeviceNominalThickness (unsigned long idx, std::string &parameter) const
 
bool getBrachyAccessoryDeviceNominalThickness (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBrachyAccessoryDeviceNominalThicknessTag () const
 
bool setBrachyAccessoryDeviceNominalThickness (unsigned long idx, std::string parameter)
 
bool getBrachyAccessoryDeviceNominalTransmission (unsigned long idx, std::string &parameter) const
 
bool getBrachyAccessoryDeviceNominalTransmission (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBrachyAccessoryDeviceNominalTransmissionTag () const
 
bool setBrachyAccessoryDeviceNominalTransmission (unsigned long idx, std::string parameter)
 
bool getBrachyAccessoryDeviceNumber (unsigned long idx, std::string &parameter) const
 
bool getBrachyAccessoryDeviceNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBrachyAccessoryDeviceNumberTag () const
 
bool setBrachyAccessoryDeviceNumber (unsigned long idx, std::string parameter)
 
bool getBrachyAccessoryDeviceType (unsigned long idx, std::string &parameter) const
 
bool getBrachyAccessoryDeviceType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBrachyAccessoryDeviceTypeTag () const
 
bool setBrachyAccessoryDeviceType (unsigned long idx, std::string parameter)
 
bool getMaterialID (unsigned long idx, std::string &parameter) const
 
bool getMaterialID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getMaterialIDTag () const
 
bool setMaterialID (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< DcmDRTBrachyAccessoryDeviceSequenceInterface::Item > dcmSequence)
 Set the DRTBrachyAccessoryDeviceSequence this interface class provides access to. More...
 
std::vector< DcmDRTBrachyAccessoryDeviceSequenceInterface::Item > getSequence () const
 Return the DRTBrachyAccessoryDeviceSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTBrachyAccessoryDeviceSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTBrachyAccessoryDeviceSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTBrachyAccessoryDeviceSequenceInterface::Item & addItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTBrachyAccessoryDeviceSequenceInterface::Item newItem)
 
bool insertItem (const size_t idx)
 Insert an item at the indicated position. More...
 
bool removeItem (const size_t idx)
 Removes the indicated item from the sequence. More...
 

Protected Attributes

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

Detailed Description

Class to provide access to DRTBrachyAccessoryDeviceSequence.

Definition at line 43 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTBrachyAccessoryDeviceSequenceInterface() [1/3]

ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::DcmDRTBrachyAccessoryDeviceSequenceInterface ( )
inline

Definition at line 113 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ DcmDRTBrachyAccessoryDeviceSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 116 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ DcmDRTBrachyAccessoryDeviceSequenceInterface() [3/3]

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

Definition at line 118 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ ~DcmDRTBrachyAccessoryDeviceSequenceInterface()

virtual ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::~DcmDRTBrachyAccessoryDeviceSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 126 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 211 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 216 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ getBrachyAccessoryDeviceID() [1/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceID() [2/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceIDTag()

std::string ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceIDTag ( ) const
inline

Definition at line 130 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getBrachyAccessoryDeviceIDTag().

◆ getBrachyAccessoryDeviceName() [1/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceName ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceName() [2/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceName ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceNameTag()

std::string ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNameTag ( ) const
inline

Definition at line 136 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getBrachyAccessoryDeviceNameTag().

◆ getBrachyAccessoryDeviceNominalThickness() [1/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNominalThickness ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceNominalThickness() [2/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNominalThickness ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceNominalThicknessTag()

std::string ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNominalThicknessTag ( ) const
inline

Definition at line 142 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getBrachyAccessoryDeviceNominalThicknessTag().

◆ getBrachyAccessoryDeviceNominalTransmission() [1/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNominalTransmission ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceNominalTransmission() [2/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNominalTransmission ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceNominalTransmissionTag()

std::string ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNominalTransmissionTag ( ) const
inline

Definition at line 148 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getBrachyAccessoryDeviceNominalTransmissionTag().

◆ getBrachyAccessoryDeviceNumber() [1/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceNumber() [2/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceNumberTag()

std::string ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceNumberTag ( ) const
inline

Definition at line 154 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getBrachyAccessoryDeviceNumberTag().

◆ getBrachyAccessoryDeviceType() [1/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceType() [2/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBrachyAccessoryDeviceTypeTag()

std::string ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getBrachyAccessoryDeviceTypeTag ( ) const
inline

Definition at line 160 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getBrachyAccessoryDeviceTypeTag().

◆ getItem()

DcmDRTBrachyAccessoryDeviceSequenceInterface::Item ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::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 202 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ getMaterialID() [1/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getMaterialID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getMaterialID() [2/2]

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getMaterialID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getMaterialIDTag()

std::string ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::getMaterialIDTag ( ) const
inline

Definition at line 166 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getMaterialIDTag().

◆ getNumberOfItems()

MLint ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::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 196 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ getReferencedROINumber() [1/2]

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

◆ getReferencedROINumber() [2/2]

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

◆ getReferencedROINumberTag()

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

Definition at line 172 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

Referenced by DRTBrachyAccessoryDeviceSequenceWrapper::getReferencedROINumberTag().

◆ getSequence()

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

Return the DRTBrachyAccessoryDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBrachyAccessoryDeviceSequence

Definition at line 184 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

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

◆ hasSequence()

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

Check if the DRTBrachyAccessoryDeviceSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 190 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::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 222 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::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 234 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

◆ setBrachyAccessoryDeviceID()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::setBrachyAccessoryDeviceID ( unsigned long  idx,
std::string  parameter 
)

◆ setBrachyAccessoryDeviceName()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::setBrachyAccessoryDeviceName ( unsigned long  idx,
std::string  parameter 
)

◆ setBrachyAccessoryDeviceNominalThickness()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::setBrachyAccessoryDeviceNominalThickness ( unsigned long  idx,
std::string  parameter 
)

◆ setBrachyAccessoryDeviceNominalTransmission()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::setBrachyAccessoryDeviceNominalTransmission ( unsigned long  idx,
std::string  parameter 
)

◆ setBrachyAccessoryDeviceNumber()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::setBrachyAccessoryDeviceNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setBrachyAccessoryDeviceType()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::setBrachyAccessoryDeviceType ( unsigned long  idx,
std::string  parameter 
)

◆ setMaterialID()

bool ml::DcmDRTBrachyAccessoryDeviceSequenceInterface::setMaterialID ( unsigned long  idx,
std::string  parameter 
)

◆ setReferencedROINumber()

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

◆ setSequence()

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

Set the DRTBrachyAccessoryDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBrachyAccessoryDeviceSequence

Definition at line 178 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 246 of file mlDcmDRTBrachyAccessoryDeviceSequenceInterface.h.

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