MeVisLab Toolbox Reference
ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface Class Reference

Class to provide access to DRTApplicatorSequenceInRTIonBeamsSessionRecordModule. More...

#include <mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface ()
 
 DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface (std::vector< DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface ()
 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 getApplicatorDescription (unsigned long idx, std::string &parameter) const
 
bool getApplicatorDescription (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getApplicatorDescriptionTag () const
 
bool setApplicatorDescription (unsigned long idx, std::string parameter)
 
bool getApplicatorID (unsigned long idx, std::string &parameter) const
 
bool getApplicatorID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getApplicatorIDTag () const
 
bool setApplicatorID (unsigned long idx, std::string parameter)
 
bool getApplicatorType (unsigned long idx, std::string &parameter) const
 
bool getApplicatorType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getApplicatorTypeTag () const
 
bool setApplicatorType (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::Item > dcmSequence)
 Set the DRTApplicatorSequenceInRTIonBeamsSessionRecordModule this interface class provides access to. More...
 
std::vector< DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::ItemgetSequence () const
 Return the DRTApplicatorSequenceInRTIonBeamsSessionRecordModule this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTApplicatorSequenceInRTIonBeamsSessionRecordModule is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::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< DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTApplicatorSequenceInRTIonBeamsSessionRecordModule.

Definition at line 43 of file mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface() [1/3]

ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface ( )
inline

◆ DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface() [2/3]

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

Default Constructor.

Definition at line 96 of file mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface() [3/3]

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

◆ ~DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface()

virtual ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::~DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::Item& ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ addItem() [2/2]

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

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

◆ getApplicatorDescription() [1/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorDescription ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getApplicatorDescription() [2/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorDescription ( unsigned long  idx,
std::string &  parameter 
) const

◆ getApplicatorDescriptionTag()

std::string ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorDescriptionTag ( ) const
inline

◆ getApplicatorID() [1/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getApplicatorID() [2/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getApplicatorIDTag()

std::string ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorIDTag ( ) const
inline

◆ getApplicatorType() [1/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getApplicatorType() [2/2]

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getApplicatorTypeTag()

std::string ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::getApplicatorTypeTag ( ) const
inline

◆ getItem()

DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::Item ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ getSequence()

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

Return the DRTApplicatorSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTApplicatorSequenceInRTIonBeamsSessionRecordModule

Definition at line 140 of file mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

◆ hasSequence()

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

Check if the DRTApplicatorSequenceInRTIonBeamsSessionRecordModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ insertItem()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ removeItem()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::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 mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

◆ setAccessoryCode()

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

◆ setApplicatorDescription()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::setApplicatorDescription ( unsigned long  idx,
std::string  parameter 
)

◆ setApplicatorID()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::setApplicatorID ( unsigned long  idx,
std::string  parameter 
)

◆ setApplicatorType()

bool ml::DcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface::setApplicatorType ( unsigned long  idx,
std::string  parameter 
)

◆ setSequence()

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

Set the DRTApplicatorSequenceInRTIonBeamsSessionRecordModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTApplicatorSequenceInRTIonBeamsSessionRecordModule

Definition at line 134 of file mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTApplicatorSequenceInRTIonBeamsSessionRecordModuleInterface.h.


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