MeVisLab Toolbox Reference
ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface Class Reference

Class to provide access to DRTReferencedBolusSequenceInRTBeamsModule. More...

#include <mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ()
 
 DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface (std::vector< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ()
 Default virtual Destructor. More...
 
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 getBolusDescription (unsigned long idx, std::string &parameter) const
 
bool getBolusDescription (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBolusDescriptionTag () const
 
bool setBolusDescription (unsigned long idx, std::string parameter)
 
bool getBolusID (unsigned long idx, std::string &parameter) const
 
bool getBolusID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBolusIDTag () const
 
bool setBolusID (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)
 
void setSequence (std::vector< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item > dcmSequence)
 Set the DRTReferencedBolusSequenceInRTBeamsModule this interface class provides access to. More...
 
std::vector< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::ItemgetSequence () const
 Return the DRTReferencedBolusSequenceInRTBeamsModule this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTReferencedBolusSequenceInRTBeamsModule is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTReferencedBolusSequenceInRTBeamsModule.

Definition at line 43 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface() [1/3]

ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ( )
inline

◆ DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface() [2/3]

ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ( std::vector< DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item dcmSequence)
inline

Default Constructor.

Definition at line 96 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

◆ DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface() [3/3]

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

◆ ~DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface()

virtual ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::~DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 167 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

◆ addItem() [2/2]

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

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

◆ getBolusDescription() [1/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusDescription ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBolusDescription() [2/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusDescription ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBolusDescriptionTag()

std::string ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusDescriptionTag ( ) const
inline

◆ getBolusID() [1/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBolusID() [2/2]

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBolusIDTag()

std::string ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::getBolusIDTag ( ) const
inline

◆ getItem()

DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::Item ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 158 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 152 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

◆ getReferencedROINumber() [1/2]

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

◆ getReferencedROINumber() [2/2]

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

◆ getReferencedROINumberTag()

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

◆ getSequence()

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

Return the DRTReferencedBolusSequenceInRTBeamsModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedBolusSequenceInRTBeamsModule

Definition at line 140 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

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

◆ hasSequence()

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

Check if the DRTReferencedBolusSequenceInRTBeamsModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

◆ insertItem()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 178 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

◆ removeItem()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::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 190 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

◆ setAccessoryCode()

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

◆ setBolusDescription()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::setBolusDescription ( unsigned long  idx,
std::string  parameter 
)

◆ setBolusID()

bool ml::DcmDRTReferencedBolusSequenceInRTBeamsModuleInterface::setBolusID ( unsigned long  idx,
std::string  parameter 
)

◆ setReferencedROINumber()

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

◆ setSequence()

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

Set the DRTReferencedBolusSequenceInRTBeamsModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTReferencedBolusSequenceInRTBeamsModule

Definition at line 134 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTReferencedBolusSequenceInRTBeamsModuleInterface.h.


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