MeVisLab Toolbox Reference
ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface Class Reference

Class to provide access to DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule. More...

#include <mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface ()
 DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface (std::vector< DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface ()
 Default virtual Destructor.
bool getDeviceSerialNumber (unsigned long idx, std::string &parameter) const
bool getDeviceSerialNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getDeviceSerialNumberTag () const
bool setDeviceSerialNumber (unsigned long idx, std::string parameter)
bool getInstitutionAddress (unsigned long idx, std::string &parameter) const
bool getInstitutionAddress (DCMTree::TreePtr item, std::string &parameter) const
std::string getInstitutionAddressTag () const
bool setInstitutionAddress (unsigned long idx, std::string parameter)
bool getInstitutionName (unsigned long idx, std::string &parameter) const
bool getInstitutionName (DCMTree::TreePtr item, std::string &parameter) const
std::string getInstitutionNameTag () const
bool setInstitutionName (unsigned long idx, std::string parameter)
bool getInstitutionalDepartmentName (unsigned long idx, std::string &parameter) const
bool getInstitutionalDepartmentName (DCMTree::TreePtr item, std::string &parameter) const
std::string getInstitutionalDepartmentNameTag () const
bool setInstitutionalDepartmentName (unsigned long idx, std::string parameter)
bool getManufacturer (unsigned long idx, std::string &parameter) const
bool getManufacturer (DCMTree::TreePtr item, std::string &parameter) const
std::string getManufacturerTag () const
bool setManufacturer (unsigned long idx, std::string parameter)
bool getManufacturerModelName (unsigned long idx, std::string &parameter) const
bool getManufacturerModelName (DCMTree::TreePtr item, std::string &parameter) const
std::string getManufacturerModelNameTag () const
bool setManufacturerModelName (unsigned long idx, std::string parameter)
bool getTreatmentMachineName (unsigned long idx, std::string &parameter) const
bool getTreatmentMachineName (DCMTree::TreePtr item, std::string &parameter) const
std::string getTreatmentMachineNameTag () const
bool setTreatmentMachineName (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::Item getItem (const size_t idx) const
DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::Item & addItem ()
void addItem (DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule.

Definition at line 43 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface() [1/3]

ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface ( )
inline

Definition at line 108 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface() [2/3]

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

Default Constructor.

Definition at line 111 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface() [3/3]

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

Definition at line 113 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ ~DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface()

virtual ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::~DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 200 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 205 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ getDeviceSerialNumber() [1/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getDeviceSerialNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getDeviceSerialNumber() [2/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getDeviceSerialNumber ( unsigned long idx,
std::string & parameter ) const

◆ getDeviceSerialNumberTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getDeviceSerialNumberTag ( ) const
inline

Definition at line 125 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ getInstitutionAddress() [1/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionAddress ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionAddress() [2/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionAddress ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionAddressTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionAddressTag ( ) const
inline

Definition at line 131 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ getInstitutionalDepartmentName() [1/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionalDepartmentName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionalDepartmentName() [2/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionalDepartmentName ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionalDepartmentNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionalDepartmentNameTag ( ) const
inline

Definition at line 143 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ getInstitutionName() [1/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionName() [2/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionName ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getInstitutionNameTag ( ) const
inline

Definition at line 137 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ getItem()

DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::Item ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::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 191 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ getManufacturer() [1/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getManufacturer ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getManufacturer() [2/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getManufacturer ( unsigned long idx,
std::string & parameter ) const

◆ getManufacturerModelName() [1/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getManufacturerModelName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getManufacturerModelName() [2/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getManufacturerModelName ( unsigned long idx,
std::string & parameter ) const

◆ getManufacturerModelNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getManufacturerModelNameTag ( ) const
inline

Definition at line 155 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ getManufacturerTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getManufacturerTag ( ) const
inline

Definition at line 149 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::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 185 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ getSequence()

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

Return the DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule

Definition at line 173 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

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

◆ getTreatmentMachineName() [1/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getTreatmentMachineName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTreatmentMachineName() [2/2]

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getTreatmentMachineName ( unsigned long idx,
std::string & parameter ) const

◆ getTreatmentMachineNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::getTreatmentMachineNameTag ( ) const
inline

Definition at line 161 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

◆ hasSequence()

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

Check if the DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::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 211 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::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 223 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ setDeviceSerialNumber()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::setDeviceSerialNumber ( unsigned long idx,
std::string parameter )

◆ setInstitutionAddress()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::setInstitutionAddress ( unsigned long idx,
std::string parameter )

◆ setInstitutionalDepartmentName()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::setInstitutionalDepartmentName ( unsigned long idx,
std::string parameter )

◆ setInstitutionName()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::setInstitutionName ( unsigned long idx,
std::string parameter )

◆ setManufacturer()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::setManufacturer ( unsigned long idx,
std::string parameter )

◆ setManufacturerModelName()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::setManufacturerModelName ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule

Definition at line 167 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

References _itemVec.

◆ setTreatmentMachineName()

bool ml::DcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface::setTreatmentMachineName ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModuleInterface.h.

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

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