ml::DcmDRTRTReferencedStudySequenceInterface Class Reference

Class to provide access to DRTRTReferencedStudySequence. More...

#include <mlDcmDRTRTReferencedStudySequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTRTReferencedStudySequenceInterface (DRTRTReferencedStudySequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTRTReferencedStudySequenceInterface ()
	Default virtual Destructor.
bool	getReferencedSOPClassUID (unsigned long idx, std::string &parameter)
bool	getReferencedSOPClassUID (DRTRTReferencedStudySequence::Item &item, std::string &parameter)
std::string	getReferencedSOPClassUIDTag () const
bool	setReferencedSOPClassUID (unsigned long idx, std::string &parameter)
bool	getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter)
bool	getReferencedSOPInstanceUID (DRTRTReferencedStudySequence::Item &item, std::string &parameter)
std::string	getReferencedSOPInstanceUIDTag () const
bool	setReferencedSOPInstanceUID (unsigned long idx, std::string &parameter)
DRTRTReferencedSeriesSequence &	getRTReferencedSeriesSequence (unsigned long idx)
std::string	getRTReferencedSeriesSequenceTag () const
void	setSequence (DRTRTReferencedStudySequence *dcmSequence)
	Set the DRTRTReferencedStudySequence this interface class provides access to.
DRTRTReferencedStudySequence *	getSequence () const
	Return the DRTRTReferencedStudySequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRTReferencedStudySequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTRTReferencedStudySequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTRTReferencedStudySequence::Item *	addItem ()
	Return number of items the internal sequence consists of.
bool	insertItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
bool	removeItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
Protected Attributes
DRTRTReferencedStudySequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTRTReferencedStudySequence.

Definition at line 43 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTRTReferencedStudySequenceInterface::DcmDRTRTReferencedStudySequenceInterface

(

DRTRTReferencedStudySequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

virtual ml::DcmDRTRTReferencedStudySequenceInterface::~DcmDRTRTReferencedStudySequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

---

Member Function Documentation

DRTRTReferencedStudySequence::Item* ml::DcmDRTRTReferencedStudySequenceInterface::addItem

(

)

[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 106 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

DRTRTReferencedStudySequence::Item* ml::DcmDRTRTReferencedStudySequenceInterface::getItem

(

const unsigned long

idx

)

[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 97 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

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 88 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

bool ml::DcmDRTRTReferencedStudySequenceInterface::getReferencedSOPClassUID	(	DRTRTReferencedStudySequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTRTReferencedStudySequenceInterface::getReferencedSOPClassUIDTag

(

)

const [inline]

Definition at line 54 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

bool ml::DcmDRTRTReferencedStudySequenceInterface::getReferencedSOPInstanceUID	(	DRTRTReferencedStudySequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTRTReferencedStudySequenceInterface::getReferencedSOPInstanceUIDTag

(

)

const [inline]

Definition at line 60 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

DRTRTReferencedSeriesSequence& ml::DcmDRTRTReferencedStudySequenceInterface::getRTReferencedSeriesSequence

(

unsigned long

idx

)

std::string ml::DcmDRTRTReferencedStudySequenceInterface::getRTReferencedSeriesSequenceTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

DRTRTReferencedStudySequence* ml::DcmDRTRTReferencedStudySequenceInterface::getSequence

(

)

const [inline]

Return the DRTRTReferencedStudySequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRTReferencedStudySequence

Definition at line 76 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

bool ml::DcmDRTRTReferencedStudySequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTRTReferencedStudySequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 82 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

bool ml::DcmDRTRTReferencedStudySequenceInterface::insertItem

(

const unsigned long

idx

)

[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 117 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

bool ml::DcmDRTRTReferencedStudySequenceInterface::removeItem

(

const unsigned long

idx

)

[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 128 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

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

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

void ml::DcmDRTRTReferencedStudySequenceInterface::setSequence

(

DRTRTReferencedStudySequence *

dcmSequence

)

[inline]

Set the DRTRTReferencedStudySequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRTReferencedStudySequence

Definition at line 70 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

---

Member Data Documentation

DRTRTReferencedStudySequence* ml::DcmDRTRTReferencedStudySequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 138 of file mlDcmDRTRTReferencedStudySequenceInterface.h.

---

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

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