ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface Class Reference

Class to provide access to DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule. More...

#include <mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface ()
	DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface (std::vector< DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface ()
	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< DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item > dcmSequence)
	Set the DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule this interface class provides access to.
std::vector< DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item >	getSequence () const
	Return the DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule this interface class provides access to.
bool	hasSequence () const
	Check if the DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position.
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence.

Protected Attributes
std::vector< DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule.

Definition at line 43 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface() [1/3]

ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface ( )

inline

Definition at line 108 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface() [2/3]

ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface ( std::vector< DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item > dcmSequence )

inline

Default Constructor.

Definition at line 111 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface() [3/3]

ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 113 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

References mlrange_cast().

~DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface()

virtual ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::~DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item & ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::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 mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

addItem() [2/2]

void ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::addItem ( DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item newItem )

inline

Definition at line 205 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

References mlrange_cast().

getDeviceSerialNumber() [1/2]

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

getDeviceSerialNumber() [2/2]

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

getDeviceSerialNumberTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getDeviceSerialNumberTag ( ) const

inline

Definition at line 125 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Referenced by DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleWrapper::getDeviceSerialNumberTag().

getInstitutionAddress() [1/2]

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

getInstitutionAddress() [2/2]

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

getInstitutionAddressTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getInstitutionAddressTag ( ) const

inline

Definition at line 131 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Referenced by DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleWrapper::getInstitutionAddressTag().

getInstitutionalDepartmentName() [1/2]

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

getInstitutionalDepartmentName() [2/2]

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

getInstitutionalDepartmentNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getInstitutionalDepartmentNameTag ( ) const

inline

Definition at line 143 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Referenced by DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleWrapper::getInstitutionalDepartmentNameTag().

getInstitutionName() [1/2]

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

getInstitutionName() [2/2]

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

getInstitutionNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getInstitutionNameTag ( ) const

inline

Definition at line 137 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Referenced by DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleWrapper::getInstitutionNameTag().

getItem()

DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::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 mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

References mlrange_cast().

getManufacturer() [1/2]

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

getManufacturer() [2/2]

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

getManufacturerModelName() [1/2]

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

getManufacturerModelName() [2/2]

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

getManufacturerModelNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getManufacturerModelNameTag ( ) const

inline

Definition at line 155 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Referenced by DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleWrapper::getManufacturerModelNameTag().

getManufacturerTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getManufacturerTag ( ) const

inline

Definition at line 149 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Referenced by DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleWrapper::getManufacturerTag().

getNumberOfItems()

MLint ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::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 mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

getSequence()

std::vector< DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item > ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getSequence ( ) const

inline

Return the DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule

Definition at line 173 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

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

getTreatmentMachineName() [1/2]

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

getTreatmentMachineName() [2/2]

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

getTreatmentMachineNameTag()

std::string ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::getTreatmentMachineNameTag ( ) const

inline

Definition at line 161 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

Referenced by DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleWrapper::getTreatmentMachineNameTag().

hasSequence()

bool ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::hasSequence ( ) const

inline

Check if the DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

insertItem()

bool ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::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 mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::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 mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

References mlrange_cast().

setDeviceSerialNumber()

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

setInstitutionAddress()

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

setInstitutionalDepartmentName()

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

setInstitutionName()

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

setManufacturer()

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

setManufacturerModelName()

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

setSequence()

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

inline

Set the DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule

Definition at line 167 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

References mlrange_cast().

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

setTreatmentMachineName()

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

Member Data Documentation

_itemVec

std::vector<DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::Item> ml::DcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface::_itemVec

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h.

---

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

• FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTTreatmentMachineSequenceInRTTreatmentMachineRecordModuleInterface.h