MeVisLab Toolbox Reference
ml::DcmDRTToleranceTableSequenceInterface Class Reference

Class to provide access to DRTToleranceTableSequence. More...

#include <mlDcmDRTToleranceTableSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTToleranceTableSequenceInterface ()
 
 DcmDRTToleranceTableSequenceInterface (std::vector< DcmDRTToleranceTableSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTToleranceTableSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTToleranceTableSequenceInterface ()
 Default virtual Destructor. More...
 
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 getGantryPitchAngleTolerance (unsigned long idx, float &parameter) const
 
bool getGantryPitchAngleTolerance (DCMTree::TreePtr item, float &parameter) const
 
std::string getGantryPitchAngleToleranceTag () const
 
bool setGantryPitchAngleTolerance (unsigned long idx, float 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 getTableTopEccentricAngleTolerance (unsigned long idx, std::string &parameter) const
 
bool getTableTopEccentricAngleTolerance (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTableTopEccentricAngleToleranceTag () const
 
bool setTableTopEccentricAngleTolerance (unsigned long idx, std::string 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 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< DcmDRTToleranceTableSequenceInterface::Item > dcmSequence)
 Set the DRTToleranceTableSequence this interface class provides access to. More...
 
std::vector< DcmDRTToleranceTableSequenceInterface::ItemgetSequence () const
 Return the DRTToleranceTableSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTToleranceTableSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTToleranceTableSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTToleranceTableSequenceInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTToleranceTableSequenceInterface::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< DcmDRTToleranceTableSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTToleranceTableSequence.

Definition at line 44 of file mlDcmDRTToleranceTableSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTToleranceTableSequenceInterface() [1/3]

ml::DcmDRTToleranceTableSequenceInterface::DcmDRTToleranceTableSequenceInterface ( )
inline

Definition at line 129 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ DcmDRTToleranceTableSequenceInterface() [2/3]

ml::DcmDRTToleranceTableSequenceInterface::DcmDRTToleranceTableSequenceInterface ( std::vector< DcmDRTToleranceTableSequenceInterface::Item dcmSequence)
inline

Default Constructor.

Definition at line 132 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ DcmDRTToleranceTableSequenceInterface() [3/3]

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

Definition at line 134 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ ~DcmDRTToleranceTableSequenceInterface()

virtual ml::DcmDRTToleranceTableSequenceInterface::~DcmDRTToleranceTableSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 142 of file mlDcmDRTToleranceTableSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 244 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 249 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ getBeamLimitingDeviceAngleTolerance() [1/2]

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

◆ getBeamLimitingDeviceAngleTolerance() [2/2]

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

◆ getBeamLimitingDeviceAngleToleranceTag()

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

◆ getBeamLimitingDeviceToleranceSequence()

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

◆ getBeamLimitingDeviceToleranceSequenceTag()

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

◆ getGantryAngleTolerance() [1/2]

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

◆ getGantryAngleTolerance() [2/2]

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

◆ getGantryAngleToleranceTag()

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

◆ getGantryPitchAngleTolerance() [1/2]

bool ml::DcmDRTToleranceTableSequenceInterface::getGantryPitchAngleTolerance ( DCMTree::TreePtr  item,
float &  parameter 
) const

◆ getGantryPitchAngleTolerance() [2/2]

bool ml::DcmDRTToleranceTableSequenceInterface::getGantryPitchAngleTolerance ( unsigned long  idx,
float &  parameter 
) const

◆ getGantryPitchAngleToleranceTag()

std::string ml::DcmDRTToleranceTableSequenceInterface::getGantryPitchAngleToleranceTag ( ) const
inline

◆ getItem()

DcmDRTToleranceTableSequenceInterface::Item ml::DcmDRTToleranceTableSequenceInterface::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 235 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTToleranceTableSequenceInterface::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 229 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ getPatientSupportAngleTolerance() [1/2]

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

◆ getPatientSupportAngleTolerance() [2/2]

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

◆ getPatientSupportAngleToleranceTag()

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

◆ getSequence()

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

Return the DRTToleranceTableSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTToleranceTableSequence

Definition at line 217 of file mlDcmDRTToleranceTableSequenceInterface.h.

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

◆ getTableTopEccentricAngleTolerance() [1/2]

bool ml::DcmDRTToleranceTableSequenceInterface::getTableTopEccentricAngleTolerance ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTableTopEccentricAngleTolerance() [2/2]

bool ml::DcmDRTToleranceTableSequenceInterface::getTableTopEccentricAngleTolerance ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTableTopEccentricAngleToleranceTag()

std::string ml::DcmDRTToleranceTableSequenceInterface::getTableTopEccentricAngleToleranceTag ( ) const
inline

◆ getTableTopLateralPositionTolerance() [1/2]

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

◆ getTableTopLateralPositionTolerance() [2/2]

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

◆ getTableTopLateralPositionToleranceTag()

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

◆ getTableTopLongitudinalPositionTolerance() [1/2]

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

◆ getTableTopLongitudinalPositionTolerance() [2/2]

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

◆ getTableTopLongitudinalPositionToleranceTag()

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

◆ getTableTopVerticalPositionTolerance() [1/2]

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

◆ getTableTopVerticalPositionTolerance() [2/2]

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

◆ getTableTopVerticalPositionToleranceTag()

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

◆ getToleranceTableLabel() [1/2]

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

◆ getToleranceTableLabel() [2/2]

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

◆ getToleranceTableLabelTag()

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

◆ getToleranceTableNumber() [1/2]

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

◆ getToleranceTableNumber() [2/2]

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

◆ getToleranceTableNumberTag()

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

◆ hasSequence()

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

Check if the DRTToleranceTableSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 223 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTToleranceTableSequenceInterface::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 255 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTToleranceTableSequenceInterface::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 267 of file mlDcmDRTToleranceTableSequenceInterface.h.

◆ setBeamLimitingDeviceAngleTolerance()

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

◆ setBeamLimitingDeviceToleranceSequence()

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

◆ setGantryAngleTolerance()

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

◆ setGantryPitchAngleTolerance()

bool ml::DcmDRTToleranceTableSequenceInterface::setGantryPitchAngleTolerance ( unsigned long  idx,
float  parameter 
)

◆ setPatientSupportAngleTolerance()

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

◆ setSequence()

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

Set the DRTToleranceTableSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTToleranceTableSequence

Definition at line 211 of file mlDcmDRTToleranceTableSequenceInterface.h.

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

◆ setTableTopEccentricAngleTolerance()

bool ml::DcmDRTToleranceTableSequenceInterface::setTableTopEccentricAngleTolerance ( unsigned long  idx,
std::string  parameter 
)

◆ setTableTopLateralPositionTolerance()

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

◆ setTableTopLongitudinalPositionTolerance()

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

◆ setTableTopVerticalPositionTolerance()

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

◆ setToleranceTableLabel()

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

◆ setToleranceTableNumber()

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 279 of file mlDcmDRTToleranceTableSequenceInterface.h.


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