MeVisLab Toolbox Reference
ml::DcmDRTFractionGroupSummarySequenceInterface Class Reference

Class to provide access to DRTFractionGroupSummarySequence. More...

#include <mlDcmDRTFractionGroupSummarySequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTFractionGroupSummarySequenceInterface ()
 DcmDRTFractionGroupSummarySequenceInterface (std::vector< DcmDRTFractionGroupSummarySequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTFractionGroupSummarySequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTFractionGroupSummarySequenceInterface ()
 Default virtual Destructor.
bool getCumulativeDoseToDoseReference (unsigned long idx, std::string &parameter) const
bool getCumulativeDoseToDoseReference (DCMTree::TreePtr item, std::string &parameter) const
std::string getCumulativeDoseToDoseReferenceTag () const
bool setCumulativeDoseToDoseReference (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 getFractionGroupType (unsigned long idx, std::string &parameter) const
bool getFractionGroupType (DCMTree::TreePtr item, std::string &parameter) const
std::string getFractionGroupTypeTag () const
bool setFractionGroupType (unsigned long idx, std::string parameter)
bool getNumberOfFractionsDelivered (unsigned long idx, std::string &parameter) const
bool getNumberOfFractionsDelivered (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfFractionsDeliveredTag () const
bool setNumberOfFractionsDelivered (unsigned long idx, std::string parameter)
bool getNumberOfFractionsPlanned (unsigned long idx, std::string &parameter) const
bool getNumberOfFractionsPlanned (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfFractionsPlannedTag () const
bool setNumberOfFractionsPlanned (unsigned long idx, std::string parameter)
bool getReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter) const
bool getReferencedDoseReferenceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedDoseReferenceNumberTag () const
bool setReferencedDoseReferenceNumber (unsigned long idx, std::string parameter)
bool getReferencedFractionGroupNumber (unsigned long idx, std::string &parameter) const
bool getReferencedFractionGroupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedFractionGroupNumberTag () const
bool setReferencedFractionGroupNumber (unsigned long idx, std::string parameter)
DcmDRTFractionStatusSummarySequenceInterface getFractionStatusSummarySequence (unsigned long idx) const
std::string getFractionStatusSummarySequenceTag () const
void setFractionStatusSummarySequence (DcmDRTFractionStatusSummarySequenceInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTFractionGroupSummarySequenceInterface::Item > dcmSequence)
std::vector< DcmDRTFractionGroupSummarySequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTFractionGroupSummarySequenceInterface::Item getItem (const size_t idx) const
DcmDRTFractionGroupSummarySequenceInterface::Item & addItem ()
void addItem (DcmDRTFractionGroupSummarySequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTFractionGroupSummarySequence.

Definition at line 44 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTFractionGroupSummarySequenceInterface() [1/3]

ml::DcmDRTFractionGroupSummarySequenceInterface::DcmDRTFractionGroupSummarySequenceInterface ( )
inline

Definition at line 114 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ DcmDRTFractionGroupSummarySequenceInterface() [2/3]

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

Default Constructor.

Definition at line 117 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ DcmDRTFractionGroupSummarySequenceInterface() [3/3]

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

Definition at line 119 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ ~DcmDRTFractionGroupSummarySequenceInterface()

virtual ml::DcmDRTFractionGroupSummarySequenceInterface::~DcmDRTFractionGroupSummarySequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 127 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTFractionGroupSummarySequenceInterface::Item & ml::DcmDRTFractionGroupSummarySequenceInterface::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 mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 216 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ getCumulativeDoseToDoseReference() [1/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getCumulativeDoseToDoseReference ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getCumulativeDoseToDoseReference() [2/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getCumulativeDoseToDoseReference ( unsigned long idx,
std::string & parameter ) const

◆ getCumulativeDoseToDoseReferenceTag()

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getCumulativeDoseToDoseReferenceTag ( ) const
inline

Definition at line 131 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getDoseReferenceDescription() [1/2]

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

◆ getDoseReferenceDescription() [2/2]

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

◆ getDoseReferenceDescriptionTag()

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

Definition at line 137 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getFractionGroupType() [1/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionGroupType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFractionGroupType() [2/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionGroupType ( unsigned long idx,
std::string & parameter ) const

◆ getFractionGroupTypeTag()

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionGroupTypeTag ( ) const
inline

Definition at line 143 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getFractionStatusSummarySequence()

DcmDRTFractionStatusSummarySequenceInterface ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionStatusSummarySequence ( unsigned long idx) const

◆ getFractionStatusSummarySequenceTag()

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionStatusSummarySequenceTag ( ) const
inline

Definition at line 172 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getItem()

DcmDRTFractionGroupSummarySequenceInterface::Item ml::DcmDRTFractionGroupSummarySequenceInterface::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 mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ getNumberOfFractionsDelivered() [1/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsDelivered ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfFractionsDelivered() [2/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsDelivered ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfFractionsDeliveredTag()

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsDeliveredTag ( ) const
inline

Definition at line 149 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getNumberOfFractionsPlanned() [1/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsPlanned ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfFractionsPlanned() [2/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsPlanned ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfFractionsPlannedTag()

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsPlannedTag ( ) const
inline

Definition at line 155 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTFractionGroupSummarySequenceInterface::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 mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ getReferencedDoseReferenceNumber() [1/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedDoseReferenceNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedDoseReferenceNumber() [2/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedDoseReferenceNumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedDoseReferenceNumberTag()

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedDoseReferenceNumberTag ( ) const
inline

Definition at line 161 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getReferencedFractionGroupNumber() [1/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedFractionGroupNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedFractionGroupNumber() [2/2]

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedFractionGroupNumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedFractionGroupNumberTag()

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedFractionGroupNumberTag ( ) const
inline

Definition at line 167 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

◆ getSequence()

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

Return the DRTFractionGroupSummarySequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTFractionGroupSummarySequence

Definition at line 184 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTFractionGroupSummarySequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 190 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::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 mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::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 mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

◆ setCumulativeDoseToDoseReference()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setCumulativeDoseToDoseReference ( unsigned long idx,
std::string parameter )

◆ setDoseReferenceDescription()

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

◆ setFractionGroupType()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setFractionGroupType ( unsigned long idx,
std::string parameter )

◆ setFractionStatusSummarySequence()

void ml::DcmDRTFractionGroupSummarySequenceInterface::setFractionStatusSummarySequence ( DcmDRTFractionStatusSummarySequenceInterface seq,
unsigned long idx )

◆ setNumberOfFractionsDelivered()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setNumberOfFractionsDelivered ( unsigned long idx,
std::string parameter )

◆ setNumberOfFractionsPlanned()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setNumberOfFractionsPlanned ( unsigned long idx,
std::string parameter )

◆ setReferencedDoseReferenceNumber()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setReferencedDoseReferenceNumber ( unsigned long idx,
std::string parameter )

◆ setReferencedFractionGroupNumber()

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setReferencedFractionGroupNumber ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTFractionGroupSummarySequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTFractionGroupSummarySequence

Definition at line 178 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 246 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

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

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