ml::DcmDRTReferencedRTPlanSequenceInterface Class Reference

Class to provide access to DRTReferencedRTPlanSequence. More...

#include <mlDcmDRTReferencedRTPlanSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedRTPlanSequenceInterface ()
	DcmDRTReferencedRTPlanSequenceInterface (std::vector< DcmDRTReferencedRTPlanSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTReferencedRTPlanSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTReferencedRTPlanSequenceInterface ()
	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)
DcmDRTReferencedFractionGroupSequenceInterface	getReferencedFractionGroupSequence (unsigned long idx) const
std::string	getReferencedFractionGroupSequenceTag () const
void	setReferencedFractionGroupSequence (DcmDRTReferencedFractionGroupSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTReferencedRTPlanSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTReferencedRTPlanSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTReferencedRTPlanSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTReferencedRTPlanSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTReferencedRTPlanSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTReferencedRTPlanSequence.

Definition at line 44 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTReferencedRTPlanSequenceInterface() [1/3]

ml::DcmDRTReferencedRTPlanSequenceInterface::DcmDRTReferencedRTPlanSequenceInterface ( )

inline

Definition at line 89 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

DcmDRTReferencedRTPlanSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 92 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

DcmDRTReferencedRTPlanSequenceInterface() [3/3]

ml::DcmDRTReferencedRTPlanSequenceInterface::DcmDRTReferencedRTPlanSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 94 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

~DcmDRTReferencedRTPlanSequenceInterface()

virtual ml::DcmDRTReferencedRTPlanSequenceInterface::~DcmDRTReferencedRTPlanSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 102 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTReferencedRTPlanSequenceInterface::Item & ml::DcmDRTReferencedRTPlanSequenceInterface::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 mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

getItem()

DcmDRTReferencedRTPlanSequenceInterface::Item ml::DcmDRTReferencedRTPlanSequenceInterface::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 mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTReferencedRTPlanSequenceInterface::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 mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

getReferencedFractionGroupSequence()

DcmDRTReferencedFractionGroupSequenceInterface ml::DcmDRTReferencedRTPlanSequenceInterface::getReferencedFractionGroupSequence

(

unsigned long

idx

)

const

getReferencedFractionGroupSequenceTag()

std::string ml::DcmDRTReferencedRTPlanSequenceInterface::getReferencedFractionGroupSequenceTag ( ) const

inline

Definition at line 117 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

getReferencedSOPClassUID() [1/2]

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

getReferencedSOPClassUID() [2/2]

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

getReferencedSOPClassUIDTag()

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

inline

Definition at line 106 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

getReferencedSOPInstanceUID() [1/2]

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

getReferencedSOPInstanceUID() [2/2]

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

getReferencedSOPInstanceUIDTag()

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

inline

Definition at line 112 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

getSequence()

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

inline

Return the DRTReferencedRTPlanSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedRTPlanSequence

Definition at line 129 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTReferencedRTPlanSequenceInterface::hasSequence ( ) const

inline

Check if the DRTReferencedRTPlanSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTReferencedRTPlanSequenceInterface::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 mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTReferencedRTPlanSequenceInterface::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 mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

setReferencedFractionGroupSequence()

void ml::DcmDRTReferencedRTPlanSequenceInterface::setReferencedFractionGroupSequence	(	DcmDRTReferencedFractionGroupSequenceInterface	seq,
		unsigned long	idx )

setReferencedSOPClassUID()

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

setReferencedSOPInstanceUID()

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

setSequence()

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

inline

Set the DRTReferencedRTPlanSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTReferencedRTPlanSequence

Definition at line 123 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

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

---

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

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