MeVisLab Toolbox Reference
ml::DcmDRTIonRangeCompensatorSequenceInterface Class Reference

Class to provide access to DRTIonRangeCompensatorSequence. More...

#include <mlDcmDRTIonRangeCompensatorSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTIonRangeCompensatorSequenceInterface ()
 DcmDRTIonRangeCompensatorSequenceInterface (std::vector< DcmDRTIonRangeCompensatorSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTIonRangeCompensatorSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTIonRangeCompensatorSequenceInterface ()
 Default virtual Destructor.
bool getAccessoryCode (unsigned long idx, std::string &parameter) const
bool getAccessoryCode (DCMTree::TreePtr item, std::string &parameter) const
std::string getAccessoryCodeTag () const
bool setAccessoryCode (unsigned long idx, std::string parameter)
bool getCompensatorColumnOffset (unsigned long idx, float &parameter) const
bool getCompensatorColumnOffset (DCMTree::TreePtr item, float &parameter) const
std::string getCompensatorColumnOffsetTag () const
bool setCompensatorColumnOffset (unsigned long idx, float parameter)
bool getCompensatorColumns (unsigned long idx, std::string &parameter) const
bool getCompensatorColumns (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorColumnsTag () const
bool setCompensatorColumns (unsigned long idx, std::string parameter)
bool getCompensatorDivergence (unsigned long idx, std::string &parameter) const
bool getCompensatorDivergence (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorDivergenceTag () const
bool setCompensatorDivergence (unsigned long idx, std::string parameter)
bool getCompensatorID (unsigned long idx, std::string &parameter) const
bool getCompensatorID (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorIDTag () const
bool setCompensatorID (unsigned long idx, std::string parameter)
bool getCompensatorMillingToolDiameter (unsigned long idx, float &parameter) const
bool getCompensatorMillingToolDiameter (DCMTree::TreePtr item, float &parameter) const
std::string getCompensatorMillingToolDiameterTag () const
bool setCompensatorMillingToolDiameter (unsigned long idx, float parameter)
bool getCompensatorMountingPosition (unsigned long idx, std::string &parameter) const
bool getCompensatorMountingPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorMountingPositionTag () const
bool setCompensatorMountingPosition (unsigned long idx, std::string parameter)
bool getCompensatorNumber (unsigned long idx, std::string &parameter) const
bool getCompensatorNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorNumberTag () const
bool setCompensatorNumber (unsigned long idx, std::string parameter)
bool getCompensatorPixelSpacing (unsigned long idx, std::string &parameter) const
bool getCompensatorPixelSpacing (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorPixelSpacingTag () const
bool setCompensatorPixelSpacing (unsigned long idx, std::string parameter)
bool getCompensatorPosition (unsigned long idx, std::string &parameter) const
bool getCompensatorPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorPositionTag () const
bool setCompensatorPosition (unsigned long idx, std::string parameter)
bool getCompensatorRelativeStoppingPowerRatio (unsigned long idx, float &parameter) const
bool getCompensatorRelativeStoppingPowerRatio (DCMTree::TreePtr item, float &parameter) const
std::string getCompensatorRelativeStoppingPowerRatioTag () const
bool setCompensatorRelativeStoppingPowerRatio (unsigned long idx, float parameter)
bool getCompensatorRows (unsigned long idx, std::string &parameter) const
bool getCompensatorRows (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorRowsTag () const
bool setCompensatorRows (unsigned long idx, std::string parameter)
bool getCompensatorThicknessData (unsigned long idx, std::string &parameter) const
bool getCompensatorThicknessData (DCMTree::TreePtr item, std::string &parameter) const
std::string getCompensatorThicknessDataTag () const
bool setCompensatorThicknessData (unsigned long idx, std::string parameter)
bool getIsocenterToCompensatorDistances (unsigned long idx, float &parameter) const
bool getIsocenterToCompensatorDistances (DCMTree::TreePtr item, float &parameter) const
std::string getIsocenterToCompensatorDistancesTag () const
bool setIsocenterToCompensatorDistances (unsigned long idx, float parameter)
bool getIsocenterToCompensatorTrayDistance (unsigned long idx, float &parameter) const
bool getIsocenterToCompensatorTrayDistance (DCMTree::TreePtr item, float &parameter) const
std::string getIsocenterToCompensatorTrayDistanceTag () const
bool setIsocenterToCompensatorTrayDistance (unsigned long idx, float 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)
void setSequence (std::vector< DcmDRTIonRangeCompensatorSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTIonRangeCompensatorSequenceInterface::ItemgetSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTIonRangeCompensatorSequenceInterface::Item getItem (const size_t idx) const
DcmDRTIonRangeCompensatorSequenceInterface::ItemaddItem ()
void addItem (DcmDRTIonRangeCompensatorSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

std::vector< DcmDRTIonRangeCompensatorSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTIonRangeCompensatorSequence.

Definition at line 43 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTIonRangeCompensatorSequenceInterface() [1/3]

ml::DcmDRTIonRangeCompensatorSequenceInterface::DcmDRTIonRangeCompensatorSequenceInterface ( )
inline

◆ DcmDRTIonRangeCompensatorSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 156 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ DcmDRTIonRangeCompensatorSequenceInterface() [3/3]

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

Definition at line 158 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTIonRangeCompensatorSequenceInterface()

virtual ml::DcmDRTIonRangeCompensatorSequenceInterface::~DcmDRTIonRangeCompensatorSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 166 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 299 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 304 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ getAccessoryCode() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getAccessoryCode ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getAccessoryCode() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getAccessoryCode ( unsigned long idx,
std::string & parameter ) const

◆ getAccessoryCodeTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getAccessoryCodeTag ( ) const
inline

◆ getCompensatorColumnOffset() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnOffset ( DCMTree::TreePtr item,
float & parameter ) const

◆ getCompensatorColumnOffset() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnOffset ( unsigned long idx,
float & parameter ) const

◆ getCompensatorColumnOffsetTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnOffsetTag ( ) const
inline

◆ getCompensatorColumns() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumns ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorColumns() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumns ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorColumnsTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorColumnsTag ( ) const
inline

◆ getCompensatorDivergence() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorDivergence ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorDivergence() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorDivergence ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorDivergenceTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorDivergenceTag ( ) const
inline

◆ getCompensatorID() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorID() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorID ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorIDTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorIDTag ( ) const
inline

◆ getCompensatorMillingToolDiameter() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMillingToolDiameter ( DCMTree::TreePtr item,
float & parameter ) const

◆ getCompensatorMillingToolDiameter() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMillingToolDiameter ( unsigned long idx,
float & parameter ) const

◆ getCompensatorMillingToolDiameterTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMillingToolDiameterTag ( ) const
inline

◆ getCompensatorMountingPosition() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMountingPosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorMountingPosition() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMountingPosition ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorMountingPositionTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorMountingPositionTag ( ) const
inline

◆ getCompensatorNumber() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorNumber() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorNumber ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorNumberTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorNumberTag ( ) const
inline

◆ getCompensatorPixelSpacing() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPixelSpacing ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorPixelSpacing() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPixelSpacing ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorPixelSpacingTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPixelSpacingTag ( ) const
inline

◆ getCompensatorPosition() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorPosition() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPosition ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorPositionTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorPositionTag ( ) const
inline

◆ getCompensatorRelativeStoppingPowerRatio() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRelativeStoppingPowerRatio ( DCMTree::TreePtr item,
float & parameter ) const

◆ getCompensatorRelativeStoppingPowerRatio() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRelativeStoppingPowerRatio ( unsigned long idx,
float & parameter ) const

◆ getCompensatorRelativeStoppingPowerRatioTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRelativeStoppingPowerRatioTag ( ) const
inline

◆ getCompensatorRows() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRows ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorRows() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRows ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorRowsTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorRowsTag ( ) const
inline

◆ getCompensatorThicknessData() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorThicknessData ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCompensatorThicknessData() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorThicknessData ( unsigned long idx,
std::string & parameter ) const

◆ getCompensatorThicknessDataTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getCompensatorThicknessDataTag ( ) const
inline

◆ getIsocenterToCompensatorDistances() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorDistances ( DCMTree::TreePtr item,
float & parameter ) const

◆ getIsocenterToCompensatorDistances() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorDistances ( unsigned long idx,
float & parameter ) const

◆ getIsocenterToCompensatorDistancesTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorDistancesTag ( ) const
inline

◆ getIsocenterToCompensatorTrayDistance() [1/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorTrayDistance ( DCMTree::TreePtr item,
float & parameter ) const

◆ getIsocenterToCompensatorTrayDistance() [2/2]

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorTrayDistance ( unsigned long idx,
float & parameter ) const

◆ getIsocenterToCompensatorTrayDistanceTag()

std::string ml::DcmDRTIonRangeCompensatorSequenceInterface::getIsocenterToCompensatorTrayDistanceTag ( ) const
inline

◆ getItem()

DcmDRTIonRangeCompensatorSequenceInterface::Item ml::DcmDRTIonRangeCompensatorSequenceInterface::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 290 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ getMaterialID() [1/2]

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

◆ getMaterialID() [2/2]

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

◆ getMaterialIDTag()

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

◆ getNumberOfItems()

MLint ml::DcmDRTIonRangeCompensatorSequenceInterface::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 284 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ getSequence()

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

Return the DRTIonRangeCompensatorSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonRangeCompensatorSequence

Definition at line 272 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTIonRangeCompensatorSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 278 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::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 310 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::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 322 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

◆ setAccessoryCode()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setAccessoryCode ( unsigned long idx,
std::string parameter )

◆ setCompensatorColumnOffset()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorColumnOffset ( unsigned long idx,
float parameter )

◆ setCompensatorColumns()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorColumns ( unsigned long idx,
std::string parameter )

◆ setCompensatorDivergence()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorDivergence ( unsigned long idx,
std::string parameter )

◆ setCompensatorID()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorID ( unsigned long idx,
std::string parameter )

◆ setCompensatorMillingToolDiameter()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorMillingToolDiameter ( unsigned long idx,
float parameter )

◆ setCompensatorMountingPosition()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorMountingPosition ( unsigned long idx,
std::string parameter )

◆ setCompensatorNumber()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorNumber ( unsigned long idx,
std::string parameter )

◆ setCompensatorPixelSpacing()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorPixelSpacing ( unsigned long idx,
std::string parameter )

◆ setCompensatorPosition()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorPosition ( unsigned long idx,
std::string parameter )

◆ setCompensatorRelativeStoppingPowerRatio()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorRelativeStoppingPowerRatio ( unsigned long idx,
float parameter )

◆ setCompensatorRows()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorRows ( unsigned long idx,
std::string parameter )

◆ setCompensatorThicknessData()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setCompensatorThicknessData ( unsigned long idx,
std::string parameter )

◆ setIsocenterToCompensatorDistances()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setIsocenterToCompensatorDistances ( unsigned long idx,
float parameter )

◆ setIsocenterToCompensatorTrayDistance()

bool ml::DcmDRTIonRangeCompensatorSequenceInterface::setIsocenterToCompensatorTrayDistance ( unsigned long idx,
float parameter )

◆ setMaterialID()

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

◆ setSequence()

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

Set the DRTIonRangeCompensatorSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonRangeCompensatorSequence

Definition at line 266 of file mlDcmDRTIonRangeCompensatorSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

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