ml::DcmDRTApplicatorSequenceInterface Class Reference

Class to provide access to DRTApplicatorSequence. More...

#include <mlDcmDRTApplicatorSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTApplicatorSequenceInterface (DRTApplicatorSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTApplicatorSequenceInterface ()
	Default virtual Destructor.
bool	getApplicatorDescription (unsigned long idx, std::string &parameter)
bool	getApplicatorDescription (DRTApplicatorSequence::Item &item, std::string &parameter)
std::string	getApplicatorDescriptionTag () const
bool	setApplicatorDescription (unsigned long idx, std::string &parameter)
bool	getApplicatorID (unsigned long idx, std::string &parameter)
bool	getApplicatorID (DRTApplicatorSequence::Item &item, std::string &parameter)
std::string	getApplicatorIDTag () const
bool	setApplicatorID (unsigned long idx, std::string &parameter)
bool	getApplicatorType (unsigned long idx, std::string &parameter)
bool	getApplicatorType (DRTApplicatorSequence::Item &item, std::string &parameter)
std::string	getApplicatorTypeTag () const
bool	setApplicatorType (unsigned long idx, std::string &parameter)
void	setSequence (DRTApplicatorSequence *dcmSequence)
	Set the DRTApplicatorSequence this interface class provides access to.
DRTApplicatorSequence *	getSequence () const
	Return the DRTApplicatorSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTApplicatorSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTApplicatorSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTApplicatorSequence::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
DRTApplicatorSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTApplicatorSequence.

Definition at line 42 of file mlDcmDRTApplicatorSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTApplicatorSequenceInterface::DcmDRTApplicatorSequenceInterface

(

DRTApplicatorSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTApplicatorSequenceInterface.h.

virtual ml::DcmDRTApplicatorSequenceInterface::~DcmDRTApplicatorSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTApplicatorSequenceInterface.h.

---

Member Function Documentation

DRTApplicatorSequence::Item* ml::DcmDRTApplicatorSequenceInterface::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 mlDcmDRTApplicatorSequenceInterface.h.

bool ml::DcmDRTApplicatorSequenceInterface::getApplicatorDescription	(	DRTApplicatorSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTApplicatorSequenceInterface::getApplicatorDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTApplicatorSequenceInterface::getApplicatorDescriptionTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTApplicatorSequenceInterface.h.

bool ml::DcmDRTApplicatorSequenceInterface::getApplicatorID	(	DRTApplicatorSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTApplicatorSequenceInterface::getApplicatorID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTApplicatorSequenceInterface::getApplicatorIDTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTApplicatorSequenceInterface.h.

bool ml::DcmDRTApplicatorSequenceInterface::getApplicatorType	(	DRTApplicatorSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTApplicatorSequenceInterface::getApplicatorType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTApplicatorSequenceInterface::getApplicatorTypeTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTApplicatorSequenceInterface.h.

DRTApplicatorSequence::Item* ml::DcmDRTApplicatorSequenceInterface::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 mlDcmDRTApplicatorSequenceInterface.h.

MLint ml::DcmDRTApplicatorSequenceInterface::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 mlDcmDRTApplicatorSequenceInterface.h.

DRTApplicatorSequence* ml::DcmDRTApplicatorSequenceInterface::getSequence

(

)

const [inline]

Return the DRTApplicatorSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTApplicatorSequence

Definition at line 77 of file mlDcmDRTApplicatorSequenceInterface.h.

bool ml::DcmDRTApplicatorSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTApplicatorSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 83 of file mlDcmDRTApplicatorSequenceInterface.h.

bool ml::DcmDRTApplicatorSequenceInterface::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 mlDcmDRTApplicatorSequenceInterface.h.

bool ml::DcmDRTApplicatorSequenceInterface::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 mlDcmDRTApplicatorSequenceInterface.h.

bool ml::DcmDRTApplicatorSequenceInterface::setApplicatorDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTApplicatorSequenceInterface::setApplicatorID	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTApplicatorSequenceInterface::setApplicatorType	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTApplicatorSequenceInterface::setSequence

(

DRTApplicatorSequence *

dcmSequence

)

[inline]

Set the DRTApplicatorSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTApplicatorSequence

Definition at line 71 of file mlDcmDRTApplicatorSequenceInterface.h.

---

Member Data Documentation

DRTApplicatorSequence* ml::DcmDRTApplicatorSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 139 of file mlDcmDRTApplicatorSequenceInterface.h.

---

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

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