ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface Class Reference

Class to provide access to DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule. More...

#include <mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface ()
	DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface (std::vector< DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface ()
	Default virtual Destructor.
bool	getReferencedSOPClassUID (unsigned long idx, std::string &parameter) const
bool	getReferencedSOPClassUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedSOPClassUIDTag () const
bool	setReferencedSOPClassUID (unsigned long idx, std::string parameter)
bool	getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter) const
bool	getReferencedSOPInstanceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedSOPInstanceUIDTag () const
bool	setReferencedSOPInstanceUID (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item > dcmSequence)
	Set the DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule this interface class provides access to.
std::vector< DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item >	getSequence () const
	Return the DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule this interface class provides access to.
bool	hasSequence () const
	Check if the DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::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< DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule.

Definition at line 43 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface() [1/3]

ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface ( )

inline

Definition at line 83 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface() [3/3]

ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

References mlrange_cast().

~DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface()

virtual ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::~DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item & ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 145 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

References mlrange_cast().

getItem()

DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::Item ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::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 136 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::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 130 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

getReferencedSOPClassUID() [1/2]

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::getReferencedSOPClassUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedSOPClassUID() [2/2]

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::getReferencedSOPClassUID	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedSOPClassUIDTag()

std::string ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::getReferencedSOPClassUIDTag ( ) const

inline

Definition at line 100 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

Referenced by DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::getReferencedSOPInstanceUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedSOPInstanceUID() [2/2]

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::getReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedSOPInstanceUIDTag()

std::string ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::getReferencedSOPInstanceUIDTag ( ) const

inline

Definition at line 106 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

Referenced by DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleWrapper::getReferencedSOPInstanceUIDTag().

getSequence()

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

inline

Return the DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule

Definition at line 118 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

insertItem()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::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 156 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::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 168 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

References mlrange_cast().

setReferencedSOPClassUID()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::setReferencedSOPClassUID	(	unsigned long	idx,
		std::string	parameter )

setReferencedSOPInstanceUID()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface::setReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModule

Definition at line 112 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralTreatmentRecordModuleInterface.h.

---

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

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