MeVisLab Toolbox Reference
ml::DcmDRTFractionGroupSequenceInterface Class Reference

Class to provide access to DRTFractionGroupSequence. More...

#include <mlDcmDRTFractionGroupSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTFractionGroupSequenceInterface ()
 DcmDRTFractionGroupSequenceInterface (std::vector< DcmDRTFractionGroupSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTFractionGroupSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTFractionGroupSequenceInterface ()
 Default virtual Destructor.
bool getFractionGroupDescription (unsigned long idx, std::string &parameter) const
bool getFractionGroupDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string getFractionGroupDescriptionTag () const
bool setFractionGroupDescription (unsigned long idx, std::string parameter)
bool getFractionGroupNumber (unsigned long idx, std::string &parameter) const
bool getFractionGroupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getFractionGroupNumberTag () const
bool setFractionGroupNumber (unsigned long idx, std::string parameter)
bool getFractionPattern (unsigned long idx, std::string &parameter) const
bool getFractionPattern (DCMTree::TreePtr item, std::string &parameter) const
std::string getFractionPatternTag () const
bool setFractionPattern (unsigned long idx, std::string parameter)
bool getNumberOfBeams (unsigned long idx, std::string &parameter) const
bool getNumberOfBeams (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfBeamsTag () const
bool setNumberOfBeams (unsigned long idx, std::string parameter)
bool getNumberOfBrachyApplicationSetups (unsigned long idx, std::string &parameter) const
bool getNumberOfBrachyApplicationSetups (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfBrachyApplicationSetupsTag () const
bool setNumberOfBrachyApplicationSetups (unsigned long idx, std::string parameter)
bool getNumberOfFractionPatternDigitsPerDay (unsigned long idx, std::string &parameter) const
bool getNumberOfFractionPatternDigitsPerDay (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfFractionPatternDigitsPerDayTag () const
bool setNumberOfFractionPatternDigitsPerDay (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 getRepeatFractionCycleLength (unsigned long idx, std::string &parameter) const
bool getRepeatFractionCycleLength (DCMTree::TreePtr item, std::string &parameter) const
std::string getRepeatFractionCycleLengthTag () const
bool setRepeatFractionCycleLength (unsigned long idx, std::string parameter)
DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface getReferencedBeamSequence (unsigned long idx) const
std::string getReferencedBeamSequenceTag () const
void setReferencedBeamSequence (DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface seq, unsigned long idx)
DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface getReferencedBrachyApplicationSetupSequence (unsigned long idx) const
std::string getReferencedBrachyApplicationSetupSequenceTag () const
void setReferencedBrachyApplicationSetupSequence (DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface seq, unsigned long idx)
DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface getReferencedDoseReferenceSequence (unsigned long idx) const
std::string getReferencedDoseReferenceSequenceTag () const
void setReferencedDoseReferenceSequence (DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface seq, unsigned long idx)
DcmDRTReferencedDoseSequenceInterface getReferencedDoseSequence (unsigned long idx) const
std::string getReferencedDoseSequenceTag () const
void setReferencedDoseSequence (DcmDRTReferencedDoseSequenceInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTFractionGroupSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTFractionGroupSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTFractionGroupSequenceInterface::Item getItem (const size_t idx) const
DcmDRTFractionGroupSequenceInterface::Item & addItem ()
void addItem (DcmDRTFractionGroupSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTFractionGroupSequence.

Definition at line 47 of file mlDcmDRTFractionGroupSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTFractionGroupSequenceInterface() [1/3]

ml::DcmDRTFractionGroupSequenceInterface::DcmDRTFractionGroupSequenceInterface ( )
inline

Definition at line 137 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ DcmDRTFractionGroupSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 140 of file mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ DcmDRTFractionGroupSequenceInterface() [3/3]

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

Definition at line 142 of file mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTFractionGroupSequenceInterface()

virtual ml::DcmDRTFractionGroupSequenceInterface::~DcmDRTFractionGroupSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 150 of file mlDcmDRTFractionGroupSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTFractionGroupSequenceInterface::Item & ml::DcmDRTFractionGroupSequenceInterface::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 mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 260 of file mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ getFractionGroupDescription() [1/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getFractionGroupDescription ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFractionGroupDescription() [2/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getFractionGroupDescription ( unsigned long idx,
std::string & parameter ) const

◆ getFractionGroupDescriptionTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getFractionGroupDescriptionTag ( ) const
inline

Definition at line 154 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getFractionGroupNumber() [1/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getFractionGroupNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFractionGroupNumber() [2/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getFractionGroupNumber ( unsigned long idx,
std::string & parameter ) const

◆ getFractionGroupNumberTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getFractionGroupNumberTag ( ) const
inline

Definition at line 160 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getFractionPattern() [1/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getFractionPattern ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getFractionPattern() [2/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getFractionPattern ( unsigned long idx,
std::string & parameter ) const

◆ getFractionPatternTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getFractionPatternTag ( ) const
inline

Definition at line 166 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getItem()

DcmDRTFractionGroupSequenceInterface::Item ml::DcmDRTFractionGroupSequenceInterface::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 mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ getNumberOfBeams() [1/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getNumberOfBeams ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfBeams() [2/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getNumberOfBeams ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfBeamsTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getNumberOfBeamsTag ( ) const
inline

Definition at line 172 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getNumberOfBrachyApplicationSetups() [1/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getNumberOfBrachyApplicationSetups ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfBrachyApplicationSetups() [2/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getNumberOfBrachyApplicationSetups ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfBrachyApplicationSetupsTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getNumberOfBrachyApplicationSetupsTag ( ) const
inline

Definition at line 178 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getNumberOfFractionPatternDigitsPerDay() [1/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getNumberOfFractionPatternDigitsPerDay ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfFractionPatternDigitsPerDay() [2/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getNumberOfFractionPatternDigitsPerDay ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfFractionPatternDigitsPerDayTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getNumberOfFractionPatternDigitsPerDayTag ( ) const
inline

Definition at line 184 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getNumberOfFractionsPlanned() [1/2]

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

◆ getNumberOfFractionsPlanned() [2/2]

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

◆ getNumberOfFractionsPlannedTag()

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

Definition at line 190 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTFractionGroupSequenceInterface::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 mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ getReferencedBeamSequence()

DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface ml::DcmDRTFractionGroupSequenceInterface::getReferencedBeamSequence ( unsigned long idx) const

◆ getReferencedBeamSequenceTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getReferencedBeamSequenceTag ( ) const
inline

Definition at line 201 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getReferencedBrachyApplicationSetupSequence()

DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface ml::DcmDRTFractionGroupSequenceInterface::getReferencedBrachyApplicationSetupSequence ( unsigned long idx) const

◆ getReferencedBrachyApplicationSetupSequenceTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getReferencedBrachyApplicationSetupSequenceTag ( ) const
inline

Definition at line 206 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getReferencedDoseReferenceSequence()

DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface ml::DcmDRTFractionGroupSequenceInterface::getReferencedDoseReferenceSequence ( unsigned long idx) const

◆ getReferencedDoseReferenceSequenceTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getReferencedDoseReferenceSequenceTag ( ) const
inline

Definition at line 211 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getReferencedDoseSequence()

DcmDRTReferencedDoseSequenceInterface ml::DcmDRTFractionGroupSequenceInterface::getReferencedDoseSequence ( unsigned long idx) const

◆ getReferencedDoseSequenceTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getReferencedDoseSequenceTag ( ) const
inline

Definition at line 216 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getRepeatFractionCycleLength() [1/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getRepeatFractionCycleLength ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRepeatFractionCycleLength() [2/2]

bool ml::DcmDRTFractionGroupSequenceInterface::getRepeatFractionCycleLength ( unsigned long idx,
std::string & parameter ) const

◆ getRepeatFractionCycleLengthTag()

std::string ml::DcmDRTFractionGroupSequenceInterface::getRepeatFractionCycleLengthTag ( ) const
inline

Definition at line 196 of file mlDcmDRTFractionGroupSequenceInterface.h.

◆ getSequence()

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

Return the DRTFractionGroupSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTFractionGroupSequence

Definition at line 228 of file mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTFractionGroupSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 234 of file mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTFractionGroupSequenceInterface::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 mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTFractionGroupSequenceInterface::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 mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

◆ setFractionGroupDescription()

bool ml::DcmDRTFractionGroupSequenceInterface::setFractionGroupDescription ( unsigned long idx,
std::string parameter )

◆ setFractionGroupNumber()

bool ml::DcmDRTFractionGroupSequenceInterface::setFractionGroupNumber ( unsigned long idx,
std::string parameter )

◆ setFractionPattern()

bool ml::DcmDRTFractionGroupSequenceInterface::setFractionPattern ( unsigned long idx,
std::string parameter )

◆ setNumberOfBeams()

bool ml::DcmDRTFractionGroupSequenceInterface::setNumberOfBeams ( unsigned long idx,
std::string parameter )

◆ setNumberOfBrachyApplicationSetups()

bool ml::DcmDRTFractionGroupSequenceInterface::setNumberOfBrachyApplicationSetups ( unsigned long idx,
std::string parameter )

◆ setNumberOfFractionPatternDigitsPerDay()

bool ml::DcmDRTFractionGroupSequenceInterface::setNumberOfFractionPatternDigitsPerDay ( unsigned long idx,
std::string parameter )

◆ setNumberOfFractionsPlanned()

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

◆ setReferencedBeamSequence()

void ml::DcmDRTFractionGroupSequenceInterface::setReferencedBeamSequence ( DcmDRTReferencedBeamSequenceInRTFractionSchemeModuleInterface seq,
unsigned long idx )

◆ setReferencedBrachyApplicationSetupSequence()

void ml::DcmDRTFractionGroupSequenceInterface::setReferencedBrachyApplicationSetupSequence ( DcmDRTReferencedBrachyApplicationSetupSequenceInRTFractionSchemeModuleInterface seq,
unsigned long idx )

◆ setReferencedDoseReferenceSequence()

void ml::DcmDRTFractionGroupSequenceInterface::setReferencedDoseReferenceSequence ( DcmDRTReferencedDoseReferenceSequenceInRTFractionSchemeModuleInterface seq,
unsigned long idx )

◆ setReferencedDoseSequence()

void ml::DcmDRTFractionGroupSequenceInterface::setReferencedDoseSequence ( DcmDRTReferencedDoseSequenceInterface seq,
unsigned long idx )

◆ setRepeatFractionCycleLength()

bool ml::DcmDRTFractionGroupSequenceInterface::setRepeatFractionCycleLength ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTFractionGroupSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTFractionGroupSequence

Definition at line 222 of file mlDcmDRTFractionGroupSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 290 of file mlDcmDRTFractionGroupSequenceInterface.h.

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

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