MeVisLab Toolbox Reference
ml::DcmDRTIonToleranceTableSequenceInterface Class Reference

Class to provide access to DRTIonToleranceTableSequence. More...

#include <mlDcmDRTIonToleranceTableSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTIonToleranceTableSequenceInterface ()
 DcmDRTIonToleranceTableSequenceInterface (std::vector< DcmDRTIonToleranceTableSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTIonToleranceTableSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTIonToleranceTableSequenceInterface ()
 Default virtual Destructor.
bool getBeamLimitingDeviceAngleTolerance (unsigned long idx, std::string &parameter) const
bool getBeamLimitingDeviceAngleTolerance (DCMTree::TreePtr item, std::string &parameter) const
std::string getBeamLimitingDeviceAngleToleranceTag () const
bool setBeamLimitingDeviceAngleTolerance (unsigned long idx, std::string parameter)
bool getGantryAngleTolerance (unsigned long idx, std::string &parameter) const
bool getGantryAngleTolerance (DCMTree::TreePtr item, std::string &parameter) const
std::string getGantryAngleToleranceTag () const
bool setGantryAngleTolerance (unsigned long idx, std::string parameter)
bool getPatientSupportAngleTolerance (unsigned long idx, std::string &parameter) const
bool getPatientSupportAngleTolerance (DCMTree::TreePtr item, std::string &parameter) const
std::string getPatientSupportAngleToleranceTag () const
bool setPatientSupportAngleTolerance (unsigned long idx, std::string parameter)
bool getSnoutPositionTolerance (unsigned long idx, float &parameter) const
bool getSnoutPositionTolerance (DCMTree::TreePtr item, float &parameter) const
std::string getSnoutPositionToleranceTag () const
bool setSnoutPositionTolerance (unsigned long idx, float parameter)
bool getTableTopLateralPositionTolerance (unsigned long idx, std::string &parameter) const
bool getTableTopLateralPositionTolerance (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopLateralPositionToleranceTag () const
bool setTableTopLateralPositionTolerance (unsigned long idx, std::string parameter)
bool getTableTopLongitudinalPositionTolerance (unsigned long idx, std::string &parameter) const
bool getTableTopLongitudinalPositionTolerance (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopLongitudinalPositionToleranceTag () const
bool setTableTopLongitudinalPositionTolerance (unsigned long idx, std::string parameter)
bool getTableTopPitchAngleTolerance (unsigned long idx, float &parameter) const
bool getTableTopPitchAngleTolerance (DCMTree::TreePtr item, float &parameter) const
std::string getTableTopPitchAngleToleranceTag () const
bool setTableTopPitchAngleTolerance (unsigned long idx, float parameter)
bool getTableTopRollAngleTolerance (unsigned long idx, float &parameter) const
bool getTableTopRollAngleTolerance (DCMTree::TreePtr item, float &parameter) const
std::string getTableTopRollAngleToleranceTag () const
bool setTableTopRollAngleTolerance (unsigned long idx, float parameter)
bool getTableTopVerticalPositionTolerance (unsigned long idx, std::string &parameter) const
bool getTableTopVerticalPositionTolerance (DCMTree::TreePtr item, std::string &parameter) const
std::string getTableTopVerticalPositionToleranceTag () const
bool setTableTopVerticalPositionTolerance (unsigned long idx, std::string parameter)
bool getToleranceTableLabel (unsigned long idx, std::string &parameter) const
bool getToleranceTableLabel (DCMTree::TreePtr item, std::string &parameter) const
std::string getToleranceTableLabelTag () const
bool setToleranceTableLabel (unsigned long idx, std::string parameter)
bool getToleranceTableNumber (unsigned long idx, std::string &parameter) const
bool getToleranceTableNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getToleranceTableNumberTag () const
bool setToleranceTableNumber (unsigned long idx, std::string parameter)
DcmDRTBeamLimitingDeviceToleranceSequenceInterface getBeamLimitingDeviceToleranceSequence (unsigned long idx) const
std::string getBeamLimitingDeviceToleranceSequenceTag () const
void setBeamLimitingDeviceToleranceSequence (DcmDRTBeamLimitingDeviceToleranceSequenceInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTIonToleranceTableSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTIonToleranceTableSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTIonToleranceTableSequenceInterface::Item getItem (const size_t idx) const
DcmDRTIonToleranceTableSequenceInterface::Item & addItem ()
void addItem (DcmDRTIonToleranceTableSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTIonToleranceTableSequence.

Definition at line 44 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTIonToleranceTableSequenceInterface() [1/3]

ml::DcmDRTIonToleranceTableSequenceInterface::DcmDRTIonToleranceTableSequenceInterface ( )
inline

Definition at line 134 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ DcmDRTIonToleranceTableSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 137 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ DcmDRTIonToleranceTableSequenceInterface() [3/3]

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

Definition at line 139 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTIonToleranceTableSequenceInterface()

virtual ml::DcmDRTIonToleranceTableSequenceInterface::~DcmDRTIonToleranceTableSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 147 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 255 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 260 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ getBeamLimitingDeviceAngleTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getBeamLimitingDeviceAngleTolerance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBeamLimitingDeviceAngleTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getBeamLimitingDeviceAngleTolerance ( unsigned long idx,
std::string & parameter ) const

◆ getBeamLimitingDeviceAngleToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getBeamLimitingDeviceAngleToleranceTag ( ) const
inline

Definition at line 151 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getBeamLimitingDeviceToleranceSequence()

DcmDRTBeamLimitingDeviceToleranceSequenceInterface ml::DcmDRTIonToleranceTableSequenceInterface::getBeamLimitingDeviceToleranceSequence ( unsigned long idx) const

◆ getBeamLimitingDeviceToleranceSequenceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getBeamLimitingDeviceToleranceSequenceTag ( ) const
inline

Definition at line 216 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getGantryAngleTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getGantryAngleTolerance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getGantryAngleTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getGantryAngleTolerance ( unsigned long idx,
std::string & parameter ) const

◆ getGantryAngleToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getGantryAngleToleranceTag ( ) const
inline

Definition at line 157 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getItem()

DcmDRTIonToleranceTableSequenceInterface::Item ml::DcmDRTIonToleranceTableSequenceInterface::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 246 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTIonToleranceTableSequenceInterface::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 240 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ getPatientSupportAngleTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getPatientSupportAngleTolerance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPatientSupportAngleTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getPatientSupportAngleTolerance ( unsigned long idx,
std::string & parameter ) const

◆ getPatientSupportAngleToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getPatientSupportAngleToleranceTag ( ) const
inline

Definition at line 163 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getSequence()

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

Return the DRTIonToleranceTableSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonToleranceTableSequence

Definition at line 228 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

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

◆ getSnoutPositionTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getSnoutPositionTolerance ( DCMTree::TreePtr item,
float & parameter ) const

◆ getSnoutPositionTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getSnoutPositionTolerance ( unsigned long idx,
float & parameter ) const

◆ getSnoutPositionToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getSnoutPositionToleranceTag ( ) const
inline

Definition at line 169 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getTableTopLateralPositionTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopLateralPositionTolerance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopLateralPositionTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopLateralPositionTolerance ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopLateralPositionToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopLateralPositionToleranceTag ( ) const
inline

Definition at line 175 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getTableTopLongitudinalPositionTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopLongitudinalPositionTolerance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopLongitudinalPositionTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopLongitudinalPositionTolerance ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopLongitudinalPositionToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopLongitudinalPositionToleranceTag ( ) const
inline

Definition at line 181 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getTableTopPitchAngleTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopPitchAngleTolerance ( DCMTree::TreePtr item,
float & parameter ) const

◆ getTableTopPitchAngleTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopPitchAngleTolerance ( unsigned long idx,
float & parameter ) const

◆ getTableTopPitchAngleToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopPitchAngleToleranceTag ( ) const
inline

Definition at line 187 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getTableTopRollAngleTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopRollAngleTolerance ( DCMTree::TreePtr item,
float & parameter ) const

◆ getTableTopRollAngleTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopRollAngleTolerance ( unsigned long idx,
float & parameter ) const

◆ getTableTopRollAngleToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopRollAngleToleranceTag ( ) const
inline

Definition at line 193 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getTableTopVerticalPositionTolerance() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopVerticalPositionTolerance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTableTopVerticalPositionTolerance() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopVerticalPositionTolerance ( unsigned long idx,
std::string & parameter ) const

◆ getTableTopVerticalPositionToleranceTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getTableTopVerticalPositionToleranceTag ( ) const
inline

Definition at line 199 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getToleranceTableLabel() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getToleranceTableLabel ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getToleranceTableLabel() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getToleranceTableLabel ( unsigned long idx,
std::string & parameter ) const

◆ getToleranceTableLabelTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getToleranceTableLabelTag ( ) const
inline

Definition at line 205 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ getToleranceTableNumber() [1/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getToleranceTableNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getToleranceTableNumber() [2/2]

bool ml::DcmDRTIonToleranceTableSequenceInterface::getToleranceTableNumber ( unsigned long idx,
std::string & parameter ) const

◆ getToleranceTableNumberTag()

std::string ml::DcmDRTIonToleranceTableSequenceInterface::getToleranceTableNumberTag ( ) const
inline

Definition at line 211 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTIonToleranceTableSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 234 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTIonToleranceTableSequenceInterface::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 266 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTIonToleranceTableSequenceInterface::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 278 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ setBeamLimitingDeviceAngleTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setBeamLimitingDeviceAngleTolerance ( unsigned long idx,
std::string parameter )

◆ setBeamLimitingDeviceToleranceSequence()

void ml::DcmDRTIonToleranceTableSequenceInterface::setBeamLimitingDeviceToleranceSequence ( DcmDRTBeamLimitingDeviceToleranceSequenceInterface seq,
unsigned long idx )

◆ setGantryAngleTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setGantryAngleTolerance ( unsigned long idx,
std::string parameter )

◆ setPatientSupportAngleTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setPatientSupportAngleTolerance ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTIonToleranceTableSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonToleranceTableSequence

Definition at line 222 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

References _itemVec.

◆ setSnoutPositionTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setSnoutPositionTolerance ( unsigned long idx,
float parameter )

◆ setTableTopLateralPositionTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setTableTopLateralPositionTolerance ( unsigned long idx,
std::string parameter )

◆ setTableTopLongitudinalPositionTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setTableTopLongitudinalPositionTolerance ( unsigned long idx,
std::string parameter )

◆ setTableTopPitchAngleTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setTableTopPitchAngleTolerance ( unsigned long idx,
float parameter )

◆ setTableTopRollAngleTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setTableTopRollAngleTolerance ( unsigned long idx,
float parameter )

◆ setTableTopVerticalPositionTolerance()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setTableTopVerticalPositionTolerance ( unsigned long idx,
std::string parameter )

◆ setToleranceTableLabel()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setToleranceTableLabel ( unsigned long idx,
std::string parameter )

◆ setToleranceTableNumber()

bool ml::DcmDRTIonToleranceTableSequenceInterface::setToleranceTableNumber ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 290 of file mlDcmDRTIonToleranceTableSequenceInterface.h.

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

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