ml::DcmDRTSetupDeviceSequenceInterface Class Reference

Class to provide access to DRTSetupDeviceSequence. More...

#include <mlDcmDRTSetupDeviceSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTSetupDeviceSequenceInterface (DRTSetupDeviceSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTSetupDeviceSequenceInterface ()
	Default virtual Destructor.
bool	getSetupDeviceDescription (unsigned long idx, std::string &parameter)
bool	getSetupDeviceDescription (DRTSetupDeviceSequence::Item &item, std::string &parameter)
std::string	getSetupDeviceDescriptionTag () const
bool	setSetupDeviceDescription (unsigned long idx, std::string &parameter)
bool	getSetupDeviceLabel (unsigned long idx, std::string &parameter)
bool	getSetupDeviceLabel (DRTSetupDeviceSequence::Item &item, std::string &parameter)
std::string	getSetupDeviceLabelTag () const
bool	setSetupDeviceLabel (unsigned long idx, std::string &parameter)
bool	getSetupDeviceParameter (unsigned long idx, std::string &parameter)
bool	getSetupDeviceParameter (DRTSetupDeviceSequence::Item &item, std::string &parameter)
std::string	getSetupDeviceParameterTag () const
bool	setSetupDeviceParameter (unsigned long idx, std::string &parameter)
bool	getSetupDeviceType (unsigned long idx, std::string &parameter)
bool	getSetupDeviceType (DRTSetupDeviceSequence::Item &item, std::string &parameter)
std::string	getSetupDeviceTypeTag () const
bool	setSetupDeviceType (unsigned long idx, std::string &parameter)
bool	getSetupReferenceDescription (unsigned long idx, std::string &parameter)
bool	getSetupReferenceDescription (DRTSetupDeviceSequence::Item &item, std::string &parameter)
std::string	getSetupReferenceDescriptionTag () const
bool	setSetupReferenceDescription (unsigned long idx, std::string &parameter)
void	setSequence (DRTSetupDeviceSequence *dcmSequence)
	Set the DRTSetupDeviceSequence this interface class provides access to.
DRTSetupDeviceSequence *	getSequence () const
	Return the DRTSetupDeviceSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTSetupDeviceSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTSetupDeviceSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTSetupDeviceSequence::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
DRTSetupDeviceSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTSetupDeviceSequence.

Definition at line 42 of file mlDcmDRTSetupDeviceSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTSetupDeviceSequenceInterface::DcmDRTSetupDeviceSequenceInterface

(

DRTSetupDeviceSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTSetupDeviceSequenceInterface.h.

virtual ml::DcmDRTSetupDeviceSequenceInterface::~DcmDRTSetupDeviceSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTSetupDeviceSequenceInterface.h.

---

Member Function Documentation

DRTSetupDeviceSequence::Item* ml::DcmDRTSetupDeviceSequenceInterface::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 119 of file mlDcmDRTSetupDeviceSequenceInterface.h.

DRTSetupDeviceSequence::Item* ml::DcmDRTSetupDeviceSequenceInterface::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 110 of file mlDcmDRTSetupDeviceSequenceInterface.h.

MLint ml::DcmDRTSetupDeviceSequenceInterface::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 101 of file mlDcmDRTSetupDeviceSequenceInterface.h.

DRTSetupDeviceSequence* ml::DcmDRTSetupDeviceSequenceInterface::getSequence

(

)

const [inline]

Return the DRTSetupDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTSetupDeviceSequence

Definition at line 89 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceDescription	(	DRTSetupDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceDescriptionTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceLabel	(	DRTSetupDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceLabel	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceLabelTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceParameter	(	DRTSetupDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceParameter	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceParameterTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceType	(	DRTSetupDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceTypeTag

(

)

const [inline]

Definition at line 71 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupReferenceDescription	(	DRTSetupDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupReferenceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupReferenceDescriptionTag

(

)

const [inline]

Definition at line 77 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTSetupDeviceSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 95 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::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 130 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::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 141 of file mlDcmDRTSetupDeviceSequenceInterface.h.

void ml::DcmDRTSetupDeviceSequenceInterface::setSequence

(

DRTSetupDeviceSequence *

dcmSequence

)

[inline]

Set the DRTSetupDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTSetupDeviceSequence

Definition at line 83 of file mlDcmDRTSetupDeviceSequenceInterface.h.

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceLabel	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceParameter	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceType	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupReferenceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

---

Member Data Documentation

DRTSetupDeviceSequence* ml::DcmDRTSetupDeviceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 151 of file mlDcmDRTSetupDeviceSequenceInterface.h.

---

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

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