ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface Class Reference

Class to provide access to DRTReferencedRTPlanSequenceInRTGeneralPlanModule. More...

#include <mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTReferencedRTPlanSequenceInRTGeneralPlanModule.

Definition at line 43 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface() [1/3]

ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface ( )

inline

Definition at line 88 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface() [3/3]

ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

~DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface()

virtual ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::~DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::Item& ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 156 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

getItem()

DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::Item ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::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 147 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

getNumberOfItems()

MLint ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::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 141 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

getReferencedSOPClassUID() [1/2]

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

getReferencedSOPClassUID() [2/2]

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

getReferencedSOPClassUIDTag()

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

inline

Definition at line 111 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

Referenced by DRTReferencedRTPlanSequenceInRTGeneralPlanModuleWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

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

getReferencedSOPInstanceUID() [2/2]

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

getReferencedSOPInstanceUIDTag()

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

inline

Definition at line 117 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

Referenced by DRTReferencedRTPlanSequenceInRTGeneralPlanModuleWrapper::getReferencedSOPInstanceUIDTag().

getRTPlanRelationship() [1/2]

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::getRTPlanRelationship	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getRTPlanRelationship() [2/2]

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::getRTPlanRelationship	(	unsigned long	idx,
		std::string &	parameter
	)		const

getRTPlanRelationshipTag()

std::string ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::getRTPlanRelationshipTag ( ) const

inline

Definition at line 105 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

Referenced by DRTReferencedRTPlanSequenceInRTGeneralPlanModuleWrapper::getRTPlanRelationshipTag().

getSequence()

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

inline

Return the DRTReferencedRTPlanSequenceInRTGeneralPlanModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedRTPlanSequenceInRTGeneralPlanModule

Definition at line 129 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

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

hasSequence()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::hasSequence ( ) const

inline

Check if the DRTReferencedRTPlanSequenceInRTGeneralPlanModule is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

insertItem()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::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 167 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

removeItem()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::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 179 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

setReferencedSOPClassUID()

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

setReferencedSOPInstanceUID()

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

setRTPlanRelationship()

bool ml::DcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface::setRTPlanRelationship	(	unsigned long	idx,
		std::string	parameter
	)

setSequence()

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

inline

Set the DRTReferencedRTPlanSequenceInRTGeneralPlanModule this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedRTPlanSequenceInRTGeneralPlanModule

Definition at line 123 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedRTPlanSequenceInRTGeneralPlanModuleInterface.h.

---

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

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