ml::DcmDRTRTReferencedStudySequenceInterface Class Reference

Class to provide access to DRTRTReferencedStudySequence. More...

#include <mlDcmDRTRTReferencedStudySequenceInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTRTReferencedStudySequence.

Definition at line 44 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTRTReferencedStudySequenceInterface() [1/3]

ml::DcmDRTRTReferencedStudySequenceInterface::DcmDRTRTReferencedStudySequenceInterface ( )

inline

Definition at line 89 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

DcmDRTRTReferencedStudySequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 92 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

DcmDRTRTReferencedStudySequenceInterface() [3/3]

ml::DcmDRTRTReferencedStudySequenceInterface::DcmDRTRTReferencedStudySequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 94 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

~DcmDRTRTReferencedStudySequenceInterface()

virtual ml::DcmDRTRTReferencedStudySequenceInterface::~DcmDRTRTReferencedStudySequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 102 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRTReferencedStudySequenceInterface::Item& ml::DcmDRTRTReferencedStudySequenceInterface::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 mlDcmDRTRTReferencedStudySequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

getItem()

DcmDRTRTReferencedStudySequenceInterface::Item ml::DcmDRTRTReferencedStudySequenceInterface::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 mlDcmDRTRTReferencedStudySequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTRTReferencedStudySequenceInterface::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 mlDcmDRTRTReferencedStudySequenceInterface.h.

getReferencedSOPClassUID() [1/2]

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

getReferencedSOPClassUID() [2/2]

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

getReferencedSOPClassUIDTag()

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

inline

Definition at line 106 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

Referenced by DRTRTReferencedStudySequenceWrapper::getReferencedSOPClassUIDTag().

getReferencedSOPInstanceUID() [1/2]

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

getReferencedSOPInstanceUID() [2/2]

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

getReferencedSOPInstanceUIDTag()

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

inline

Definition at line 112 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

Referenced by DRTRTReferencedStudySequenceWrapper::getReferencedSOPInstanceUIDTag().

getRTReferencedSeriesSequence()

DcmDRTRTReferencedSeriesSequenceInterface ml::DcmDRTRTReferencedStudySequenceInterface::getRTReferencedSeriesSequence

(

unsigned long

idx

)

const

getRTReferencedSeriesSequenceTag()

std::string ml::DcmDRTRTReferencedStudySequenceInterface::getRTReferencedSeriesSequenceTag ( ) const

inline

Definition at line 117 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

Referenced by DRTRTReferencedStudySequenceWrapper::getRTReferencedSeriesSequenceTag().

getSequence()

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

inline

Return the DRTRTReferencedStudySequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTReferencedStudySequence

Definition at line 129 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTRTReferencedStudySequenceInterface::hasSequence ( ) const

inline

Check if the DRTRTReferencedStudySequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

insertItem()

bool ml::DcmDRTRTReferencedStudySequenceInterface::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 mlDcmDRTRTReferencedStudySequenceInterface.h.

removeItem()

bool ml::DcmDRTRTReferencedStudySequenceInterface::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 mlDcmDRTRTReferencedStudySequenceInterface.h.

setReferencedSOPClassUID()

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

setReferencedSOPInstanceUID()

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

setRTReferencedSeriesSequence()

void ml::DcmDRTRTReferencedStudySequenceInterface::setRTReferencedSeriesSequence	(	DcmDRTRTReferencedSeriesSequenceInterface	seq,
		unsigned long	idx
	)

setSequence()

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

inline

Set the DRTRTReferencedStudySequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTReferencedStudySequence

Definition at line 123 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

---

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

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