ml::DcmDRTContourImageSequenceInterface Class Reference

Class to provide access to DRTContourImageSequence. More...

#include <mlDcmDRTContourImageSequenceInterface.h>

List of all members.

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

---

Detailed Description

Class to provide access to DRTContourImageSequence.

Definition at line 42 of file mlDcmDRTContourImageSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTContourImageSequenceInterface::DcmDRTContourImageSequenceInterface

(

DRTContourImageSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTContourImageSequenceInterface.h.

virtual ml::DcmDRTContourImageSequenceInterface::~DcmDRTContourImageSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTContourImageSequenceInterface.h.

---

Member Function Documentation

DRTContourImageSequence::Item* ml::DcmDRTContourImageSequenceInterface::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 113 of file mlDcmDRTContourImageSequenceInterface.h.

DRTContourImageSequence::Item* ml::DcmDRTContourImageSequenceInterface::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 104 of file mlDcmDRTContourImageSequenceInterface.h.

MLint ml::DcmDRTContourImageSequenceInterface::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 95 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::getReferencedFrameNumber	(	DRTContourImageSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTContourImageSequenceInterface::getReferencedFrameNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTContourImageSequenceInterface::getReferencedFrameNumberTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::getReferencedSegmentNumber	(	DRTContourImageSequence::Item &	item,
		MLuint16 &	parameter
	)

bool ml::DcmDRTContourImageSequenceInterface::getReferencedSegmentNumber	(	unsigned long	idx,
		MLuint16 &	parameter
	)

std::string ml::DcmDRTContourImageSequenceInterface::getReferencedSegmentNumberTag

(

)

const [inline]

Definition at line 71 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::getReferencedSOPClassUID	(	DRTContourImageSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTContourImageSequenceInterface::getReferencedSOPClassUIDTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::getReferencedSOPInstanceUID	(	DRTContourImageSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTContourImageSequenceInterface::getReferencedSOPInstanceUIDTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTContourImageSequenceInterface.h.

DRTContourImageSequence* ml::DcmDRTContourImageSequenceInterface::getSequence

(

)

const [inline]

Return the DRTContourImageSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTContourImageSequence

Definition at line 83 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTContourImageSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 89 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::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 124 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::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 135 of file mlDcmDRTContourImageSequenceInterface.h.

bool ml::DcmDRTContourImageSequenceInterface::setReferencedFrameNumber	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTContourImageSequenceInterface::setReferencedSegmentNumber	(	unsigned long	idx,
		MLuint16 &	parameter
	)

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

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

void ml::DcmDRTContourImageSequenceInterface::setSequence

(

DRTContourImageSequence *

dcmSequence

)

[inline]

Set the DRTContourImageSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTContourImageSequence

Definition at line 77 of file mlDcmDRTContourImageSequenceInterface.h.

---

Member Data Documentation

DRTContourImageSequence* ml::DcmDRTContourImageSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 145 of file mlDcmDRTContourImageSequenceInterface.h.

---

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

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