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

Class to provide access to DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule. More...

#include <mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ()
 
 DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface (std::vector< DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ()
 Default virtual Destructor. More...
 
bool getRangeModulatorGatingStartValue (unsigned long idx, float &parameter) const
 
bool getRangeModulatorGatingStartValue (DCMTree::TreePtr item, float &parameter) const
 
std::string getRangeModulatorGatingStartValueTag () const
 
bool setRangeModulatorGatingStartValue (unsigned long idx, float parameter)
 
bool getRangeModulatorGatingStopValue (unsigned long idx, float &parameter) const
 
bool getRangeModulatorGatingStopValue (DCMTree::TreePtr item, float &parameter) const
 
std::string getRangeModulatorGatingStopValueTag () const
 
bool setRangeModulatorGatingStopValue (unsigned long idx, float parameter)
 
bool getReferencedRangeModulatorNumber (unsigned long idx, std::string &parameter) const
 
bool getReferencedRangeModulatorNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getReferencedRangeModulatorNumberTag () const
 
bool setReferencedRangeModulatorNumber (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
 Set the DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to. More...
 
std::vector< DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > getSequence () const
 Return the DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item & addItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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< DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule.

Definition at line 43 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [1/3]

ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( )
inline

Definition at line 88 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [2/3]

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

Default Constructor.

Definition at line 91 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface() [3/3]

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

Definition at line 93 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ ~DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface()

virtual ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::~DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 156 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ addItem() [2/2]

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

Definition at line 161 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ getItem()

DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::Item ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 147 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 141 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ getRangeModulatorGatingStartValue() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getRangeModulatorGatingStartValue ( DCMTree::TreePtr  item,
float &  parameter 
) const

◆ getRangeModulatorGatingStartValue() [2/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getRangeModulatorGatingStartValue ( unsigned long  idx,
float &  parameter 
) const

◆ getRangeModulatorGatingStartValueTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getRangeModulatorGatingStartValueTag ( ) const
inline

Definition at line 105 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleWrapper::getRangeModulatorGatingStartValueTag().

◆ getRangeModulatorGatingStopValue() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getRangeModulatorGatingStopValue ( DCMTree::TreePtr  item,
float &  parameter 
) const

◆ getRangeModulatorGatingStopValue() [2/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getRangeModulatorGatingStopValue ( unsigned long  idx,
float &  parameter 
) const

◆ getRangeModulatorGatingStopValueTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getRangeModulatorGatingStopValueTag ( ) const
inline

Definition at line 111 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleWrapper::getRangeModulatorGatingStopValueTag().

◆ getReferencedRangeModulatorNumber() [1/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getReferencedRangeModulatorNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getReferencedRangeModulatorNumber() [2/2]

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getReferencedRangeModulatorNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getReferencedRangeModulatorNumberTag()

std::string ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::getReferencedRangeModulatorNumberTag ( ) const
inline

Definition at line 117 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Referenced by DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleWrapper::getReferencedRangeModulatorNumberTag().

◆ getSequence()

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

Return the DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule

Definition at line 129 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

◆ hasSequence()

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

Check if the DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ insertItem()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 167 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ removeItem()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::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 179 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ setRangeModulatorGatingStartValue()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::setRangeModulatorGatingStartValue ( unsigned long  idx,
float  parameter 
)

◆ setRangeModulatorGatingStopValue()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::setRangeModulatorGatingStopValue ( unsigned long  idx,
float  parameter 
)

◆ setReferencedRangeModulatorNumber()

bool ml::DcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface::setReferencedRangeModulatorNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setSequence()

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

Set the DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModule

Definition at line 123 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTRangeModulatorSettingsSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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