ml::DcmDRTReferencedRTPlanSequenceInterface Class Reference

Class to provide access to DRTReferencedRTPlanSequence. More...

#include <mlDcmDRTReferencedRTPlanSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTReferencedRTPlanSequenceInterface (DRTReferencedRTPlanSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTReferencedRTPlanSequenceInterface ()
	Default virtual Destructor.
bool	getRTPlanRelationship (unsigned long idx, std::string &parameter)
bool	getRTPlanRelationship (DRTReferencedRTPlanSequence::Item &item, std::string &parameter)
std::string	getRTPlanRelationshipTag () const
bool	setRTPlanRelationship (unsigned long idx, std::string &parameter)
bool	getReferencedSOPClassUID (unsigned long idx, std::string &parameter)
bool	getReferencedSOPClassUID (DRTReferencedRTPlanSequence::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 (DRTReferencedRTPlanSequence::Item &item, std::string &parameter)
std::string	getReferencedSOPInstanceUIDTag () const
bool	setReferencedSOPInstanceUID (unsigned long idx, std::string &parameter)
void	setSequence (DRTReferencedRTPlanSequence *dcmSequence)
	Set the DRTReferencedRTPlanSequence this interface class provides access to.
DRTReferencedRTPlanSequence *	getSequence () const
	Return the DRTReferencedRTPlanSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTReferencedRTPlanSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTReferencedRTPlanSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTReferencedRTPlanSequence::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
DRTReferencedRTPlanSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTReferencedRTPlanSequence.

Definition at line 42 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTReferencedRTPlanSequenceInterface::DcmDRTReferencedRTPlanSequenceInterface

(

DRTReferencedRTPlanSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

virtual ml::DcmDRTReferencedRTPlanSequenceInterface::~DcmDRTReferencedRTPlanSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

---

Member Function Documentation

DRTReferencedRTPlanSequence::Item* ml::DcmDRTReferencedRTPlanSequenceInterface::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 107 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

DRTReferencedRTPlanSequence::Item* ml::DcmDRTReferencedRTPlanSequenceInterface::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 98 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

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 89 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

bool ml::DcmDRTReferencedRTPlanSequenceInterface::getReferencedSOPClassUID	(	DRTReferencedRTPlanSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTReferencedRTPlanSequenceInterface::getReferencedSOPClassUIDTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

bool ml::DcmDRTReferencedRTPlanSequenceInterface::getReferencedSOPInstanceUID	(	DRTReferencedRTPlanSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTReferencedRTPlanSequenceInterface::getReferencedSOPInstanceUIDTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

bool ml::DcmDRTReferencedRTPlanSequenceInterface::getRTPlanRelationship	(	DRTReferencedRTPlanSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTReferencedRTPlanSequenceInterface::getRTPlanRelationshipTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

DRTReferencedRTPlanSequence* ml::DcmDRTReferencedRTPlanSequenceInterface::getSequence

(

)

const [inline]

Return the DRTReferencedRTPlanSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedRTPlanSequence

Definition at line 77 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

bool ml::DcmDRTReferencedRTPlanSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTReferencedRTPlanSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 83 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

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

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

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

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

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

void ml::DcmDRTReferencedRTPlanSequenceInterface::setSequence

(

DRTReferencedRTPlanSequence *

dcmSequence

)

[inline]

Set the DRTReferencedRTPlanSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTReferencedRTPlanSequence

Definition at line 71 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

---

Member Data Documentation

DRTReferencedRTPlanSequence* ml::DcmDRTReferencedRTPlanSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 139 of file mlDcmDRTReferencedRTPlanSequenceInterface.h.

---

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

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