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

Class to provide access to DRTDoseReferenceSequence. More...

#include <mlDcmDRTDoseReferenceSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTDoseReferenceSequenceInterface ()
 
 DcmDRTDoseReferenceSequenceInterface (std::vector< DcmDRTDoseReferenceSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTDoseReferenceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTDoseReferenceSequenceInterface ()
 Default virtual Destructor. More...
 
bool getConstraintWeight (unsigned long idx, std::string &parameter) const
 
bool getConstraintWeight (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getConstraintWeightTag () const
 
bool setConstraintWeight (unsigned long idx, std::string parameter)
 
bool getDeliveryMaximumDose (unsigned long idx, std::string &parameter) const
 
bool getDeliveryMaximumDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDeliveryMaximumDoseTag () const
 
bool setDeliveryMaximumDose (unsigned long idx, std::string parameter)
 
bool getDeliveryWarningDose (unsigned long idx, std::string &parameter) const
 
bool getDeliveryWarningDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDeliveryWarningDoseTag () const
 
bool setDeliveryWarningDose (unsigned long idx, std::string parameter)
 
bool getDoseReferenceDescription (unsigned long idx, std::string &parameter) const
 
bool getDoseReferenceDescription (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDoseReferenceDescriptionTag () const
 
bool setDoseReferenceDescription (unsigned long idx, std::string parameter)
 
bool getDoseReferenceNumber (unsigned long idx, std::string &parameter) const
 
bool getDoseReferenceNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDoseReferenceNumberTag () const
 
bool setDoseReferenceNumber (unsigned long idx, std::string parameter)
 
bool getDoseReferencePointCoordinates (unsigned long idx, std::string &parameter) const
 
bool getDoseReferencePointCoordinates (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDoseReferencePointCoordinatesTag () const
 
bool setDoseReferencePointCoordinates (unsigned long idx, std::string parameter)
 
bool getDoseReferenceStructureType (unsigned long idx, std::string &parameter) const
 
bool getDoseReferenceStructureType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDoseReferenceStructureTypeTag () const
 
bool setDoseReferenceStructureType (unsigned long idx, std::string parameter)
 
bool getDoseReferenceType (unsigned long idx, std::string &parameter) const
 
bool getDoseReferenceType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDoseReferenceTypeTag () const
 
bool setDoseReferenceType (unsigned long idx, std::string parameter)
 
bool getDoseReferenceUID (unsigned long idx, std::string &parameter) const
 
bool getDoseReferenceUID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDoseReferenceUIDTag () const
 
bool setDoseReferenceUID (unsigned long idx, std::string parameter)
 
bool getNominalPriorDose (unsigned long idx, std::string &parameter) const
 
bool getNominalPriorDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getNominalPriorDoseTag () const
 
bool setNominalPriorDose (unsigned long idx, std::string parameter)
 
bool getOrganAtRiskFullVolumeDose (unsigned long idx, std::string &parameter) const
 
bool getOrganAtRiskFullVolumeDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getOrganAtRiskFullVolumeDoseTag () const
 
bool setOrganAtRiskFullVolumeDose (unsigned long idx, std::string parameter)
 
bool getOrganAtRiskLimitDose (unsigned long idx, std::string &parameter) const
 
bool getOrganAtRiskLimitDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getOrganAtRiskLimitDoseTag () const
 
bool setOrganAtRiskLimitDose (unsigned long idx, std::string parameter)
 
bool getOrganAtRiskMaximumDose (unsigned long idx, std::string &parameter) const
 
bool getOrganAtRiskMaximumDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getOrganAtRiskMaximumDoseTag () const
 
bool setOrganAtRiskMaximumDose (unsigned long idx, std::string parameter)
 
bool getOrganAtRiskOverdoseVolumeFraction (unsigned long idx, std::string &parameter) const
 
bool getOrganAtRiskOverdoseVolumeFraction (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getOrganAtRiskOverdoseVolumeFractionTag () const
 
bool setOrganAtRiskOverdoseVolumeFraction (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)
 
bool getTargetMaximumDose (unsigned long idx, std::string &parameter) const
 
bool getTargetMaximumDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTargetMaximumDoseTag () const
 
bool setTargetMaximumDose (unsigned long idx, std::string parameter)
 
bool getTargetMinimumDose (unsigned long idx, std::string &parameter) const
 
bool getTargetMinimumDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTargetMinimumDoseTag () const
 
bool setTargetMinimumDose (unsigned long idx, std::string parameter)
 
bool getTargetPrescriptionDose (unsigned long idx, std::string &parameter) const
 
bool getTargetPrescriptionDose (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTargetPrescriptionDoseTag () const
 
bool setTargetPrescriptionDose (unsigned long idx, std::string parameter)
 
bool getTargetUnderdoseVolumeFraction (unsigned long idx, std::string &parameter) const
 
bool getTargetUnderdoseVolumeFraction (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTargetUnderdoseVolumeFractionTag () const
 
bool setTargetUnderdoseVolumeFraction (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTDoseReferenceSequenceInterface::Item > dcmSequence)
 Set the DRTDoseReferenceSequence this interface class provides access to. More...
 
std::vector< DcmDRTDoseReferenceSequenceInterface::Item > getSequence () const
 Return the DRTDoseReferenceSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTDoseReferenceSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTDoseReferenceSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTDoseReferenceSequenceInterface::Item & addItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTDoseReferenceSequenceInterface::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< DcmDRTDoseReferenceSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTDoseReferenceSequence.

Definition at line 43 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTDoseReferenceSequenceInterface() [1/3]

ml::DcmDRTDoseReferenceSequenceInterface::DcmDRTDoseReferenceSequenceInterface ( )
inline

Definition at line 168 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ DcmDRTDoseReferenceSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 171 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ DcmDRTDoseReferenceSequenceInterface() [3/3]

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

Definition at line 173 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ ~DcmDRTDoseReferenceSequenceInterface()

virtual ml::DcmDRTDoseReferenceSequenceInterface::~DcmDRTDoseReferenceSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 181 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 332 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 337 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ getConstraintWeight() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getConstraintWeight ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getConstraintWeight() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getConstraintWeight ( unsigned long  idx,
std::string &  parameter 
) const

◆ getConstraintWeightTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getConstraintWeightTag ( ) const
inline

Definition at line 185 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getConstraintWeightTag().

◆ getDeliveryMaximumDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryMaximumDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDeliveryMaximumDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryMaximumDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDeliveryMaximumDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryMaximumDoseTag ( ) const
inline

Definition at line 191 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDeliveryMaximumDoseTag().

◆ getDeliveryWarningDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryWarningDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDeliveryWarningDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryWarningDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDeliveryWarningDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDeliveryWarningDoseTag ( ) const
inline

Definition at line 197 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDeliveryWarningDoseTag().

◆ getDoseReferenceDescription() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceDescription ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDoseReferenceDescription() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceDescription ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDoseReferenceDescriptionTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceDescriptionTag ( ) const
inline

Definition at line 203 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDoseReferenceDescriptionTag().

◆ getDoseReferenceNumber() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDoseReferenceNumber() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDoseReferenceNumberTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceNumberTag ( ) const
inline

Definition at line 209 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDoseReferenceNumberTag().

◆ getDoseReferencePointCoordinates() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferencePointCoordinates ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDoseReferencePointCoordinates() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferencePointCoordinates ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDoseReferencePointCoordinatesTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferencePointCoordinatesTag ( ) const
inline

Definition at line 215 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDoseReferencePointCoordinatesTag().

◆ getDoseReferenceStructureType() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceStructureType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDoseReferenceStructureType() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceStructureType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDoseReferenceStructureTypeTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceStructureTypeTag ( ) const
inline

Definition at line 221 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDoseReferenceStructureTypeTag().

◆ getDoseReferenceType() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDoseReferenceType() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDoseReferenceTypeTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceTypeTag ( ) const
inline

Definition at line 227 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDoseReferenceTypeTag().

◆ getDoseReferenceUID() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceUID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDoseReferenceUID() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceUID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDoseReferenceUIDTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getDoseReferenceUIDTag ( ) const
inline

Definition at line 233 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getDoseReferenceUIDTag().

◆ getItem()

DcmDRTDoseReferenceSequenceInterface::Item ml::DcmDRTDoseReferenceSequenceInterface::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 323 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ getNominalPriorDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getNominalPriorDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getNominalPriorDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getNominalPriorDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getNominalPriorDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getNominalPriorDoseTag ( ) const
inline

Definition at line 239 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getNominalPriorDoseTag().

◆ getNumberOfItems()

MLint ml::DcmDRTDoseReferenceSequenceInterface::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 317 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ getOrganAtRiskFullVolumeDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskFullVolumeDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getOrganAtRiskFullVolumeDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskFullVolumeDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getOrganAtRiskFullVolumeDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskFullVolumeDoseTag ( ) const
inline

Definition at line 245 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getOrganAtRiskFullVolumeDoseTag().

◆ getOrganAtRiskLimitDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskLimitDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getOrganAtRiskLimitDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskLimitDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getOrganAtRiskLimitDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskLimitDoseTag ( ) const
inline

Definition at line 251 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getOrganAtRiskLimitDoseTag().

◆ getOrganAtRiskMaximumDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskMaximumDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getOrganAtRiskMaximumDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskMaximumDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getOrganAtRiskMaximumDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskMaximumDoseTag ( ) const
inline

Definition at line 257 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getOrganAtRiskMaximumDoseTag().

◆ getOrganAtRiskOverdoseVolumeFraction() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskOverdoseVolumeFraction ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getOrganAtRiskOverdoseVolumeFraction() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskOverdoseVolumeFraction ( unsigned long  idx,
std::string &  parameter 
) const

◆ getOrganAtRiskOverdoseVolumeFractionTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getOrganAtRiskOverdoseVolumeFractionTag ( ) const
inline

Definition at line 263 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getOrganAtRiskOverdoseVolumeFractionTag().

◆ getReferencedROINumber() [1/2]

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

◆ getReferencedROINumber() [2/2]

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

◆ getReferencedROINumberTag()

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

Definition at line 269 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getReferencedROINumberTag().

◆ getSequence()

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

Return the DRTDoseReferenceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTDoseReferenceSequence

Definition at line 305 of file mlDcmDRTDoseReferenceSequenceInterface.h.

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

◆ getTargetMaximumDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMaximumDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTargetMaximumDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMaximumDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTargetMaximumDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetMaximumDoseTag ( ) const
inline

Definition at line 275 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getTargetMaximumDoseTag().

◆ getTargetMinimumDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMinimumDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTargetMinimumDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetMinimumDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTargetMinimumDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetMinimumDoseTag ( ) const
inline

Definition at line 281 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getTargetMinimumDoseTag().

◆ getTargetPrescriptionDose() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetPrescriptionDose ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTargetPrescriptionDose() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetPrescriptionDose ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTargetPrescriptionDoseTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetPrescriptionDoseTag ( ) const
inline

Definition at line 287 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getTargetPrescriptionDoseTag().

◆ getTargetUnderdoseVolumeFraction() [1/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetUnderdoseVolumeFraction ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTargetUnderdoseVolumeFraction() [2/2]

bool ml::DcmDRTDoseReferenceSequenceInterface::getTargetUnderdoseVolumeFraction ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTargetUnderdoseVolumeFractionTag()

std::string ml::DcmDRTDoseReferenceSequenceInterface::getTargetUnderdoseVolumeFractionTag ( ) const
inline

Definition at line 293 of file mlDcmDRTDoseReferenceSequenceInterface.h.

Referenced by DRTDoseReferenceSequenceWrapper::getTargetUnderdoseVolumeFractionTag().

◆ hasSequence()

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

Check if the DRTDoseReferenceSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 311 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTDoseReferenceSequenceInterface::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 343 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTDoseReferenceSequenceInterface::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 355 of file mlDcmDRTDoseReferenceSequenceInterface.h.

◆ setConstraintWeight()

bool ml::DcmDRTDoseReferenceSequenceInterface::setConstraintWeight ( unsigned long  idx,
std::string  parameter 
)

◆ setDeliveryMaximumDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDeliveryMaximumDose ( unsigned long  idx,
std::string  parameter 
)

◆ setDeliveryWarningDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDeliveryWarningDose ( unsigned long  idx,
std::string  parameter 
)

◆ setDoseReferenceDescription()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceDescription ( unsigned long  idx,
std::string  parameter 
)

◆ setDoseReferenceNumber()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setDoseReferencePointCoordinates()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferencePointCoordinates ( unsigned long  idx,
std::string  parameter 
)

◆ setDoseReferenceStructureType()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceStructureType ( unsigned long  idx,
std::string  parameter 
)

◆ setDoseReferenceType()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceType ( unsigned long  idx,
std::string  parameter 
)

◆ setDoseReferenceUID()

bool ml::DcmDRTDoseReferenceSequenceInterface::setDoseReferenceUID ( unsigned long  idx,
std::string  parameter 
)

◆ setNominalPriorDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setNominalPriorDose ( unsigned long  idx,
std::string  parameter 
)

◆ setOrganAtRiskFullVolumeDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskFullVolumeDose ( unsigned long  idx,
std::string  parameter 
)

◆ setOrganAtRiskLimitDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskLimitDose ( unsigned long  idx,
std::string  parameter 
)

◆ setOrganAtRiskMaximumDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskMaximumDose ( unsigned long  idx,
std::string  parameter 
)

◆ setOrganAtRiskOverdoseVolumeFraction()

bool ml::DcmDRTDoseReferenceSequenceInterface::setOrganAtRiskOverdoseVolumeFraction ( unsigned long  idx,
std::string  parameter 
)

◆ setReferencedROINumber()

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

◆ setSequence()

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

Set the DRTDoseReferenceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTDoseReferenceSequence

Definition at line 299 of file mlDcmDRTDoseReferenceSequenceInterface.h.

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

◆ setTargetMaximumDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetMaximumDose ( unsigned long  idx,
std::string  parameter 
)

◆ setTargetMinimumDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetMinimumDose ( unsigned long  idx,
std::string  parameter 
)

◆ setTargetPrescriptionDose()

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetPrescriptionDose ( unsigned long  idx,
std::string  parameter 
)

◆ setTargetUnderdoseVolumeFraction()

bool ml::DcmDRTDoseReferenceSequenceInterface::setTargetUnderdoseVolumeFraction ( unsigned long  idx,
std::string  parameter 
)

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 367 of file mlDcmDRTDoseReferenceSequenceInterface.h.

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