ml::DcmDRTShieldingDeviceSequenceInterface Class Reference

Class to provide access to DRTShieldingDeviceSequence. More...

#include <mlDcmDRTShieldingDeviceSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTShieldingDeviceSequenceInterface (DRTShieldingDeviceSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTShieldingDeviceSequenceInterface ()
	Default virtual Destructor.
bool	getAccessoryCode (unsigned long idx, std::string &parameter)
bool	getAccessoryCode (DRTShieldingDeviceSequence::Item &item, std::string &parameter)
std::string	getAccessoryCodeTag () const
bool	setAccessoryCode (unsigned long idx, std::string &parameter)
bool	getShieldingDeviceDescription (unsigned long idx, std::string &parameter)
bool	getShieldingDeviceDescription (DRTShieldingDeviceSequence::Item &item, std::string &parameter)
std::string	getShieldingDeviceDescriptionTag () const
bool	setShieldingDeviceDescription (unsigned long idx, std::string &parameter)
bool	getShieldingDeviceLabel (unsigned long idx, std::string &parameter)
bool	getShieldingDeviceLabel (DRTShieldingDeviceSequence::Item &item, std::string &parameter)
std::string	getShieldingDeviceLabelTag () const
bool	setShieldingDeviceLabel (unsigned long idx, std::string &parameter)
bool	getShieldingDevicePosition (unsigned long idx, std::string &parameter)
bool	getShieldingDevicePosition (DRTShieldingDeviceSequence::Item &item, std::string &parameter)
std::string	getShieldingDevicePositionTag () const
bool	setShieldingDevicePosition (unsigned long idx, std::string &parameter)
bool	getShieldingDeviceType (unsigned long idx, std::string &parameter)
bool	getShieldingDeviceType (DRTShieldingDeviceSequence::Item &item, std::string &parameter)
std::string	getShieldingDeviceTypeTag () const
bool	setShieldingDeviceType (unsigned long idx, std::string &parameter)
void	setSequence (DRTShieldingDeviceSequence *dcmSequence)
	Set the DRTShieldingDeviceSequence this interface class provides access to.
DRTShieldingDeviceSequence *	getSequence () const
	Return the DRTShieldingDeviceSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTShieldingDeviceSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTShieldingDeviceSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTShieldingDeviceSequence::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
DRTShieldingDeviceSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTShieldingDeviceSequence.

Definition at line 42 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTShieldingDeviceSequenceInterface::DcmDRTShieldingDeviceSequenceInterface

(

DRTShieldingDeviceSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

virtual ml::DcmDRTShieldingDeviceSequenceInterface::~DcmDRTShieldingDeviceSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

---

Member Function Documentation

DRTShieldingDeviceSequence::Item* ml::DcmDRTShieldingDeviceSequenceInterface::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 mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::getAccessoryCode	(	DRTShieldingDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::getAccessoryCode	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getAccessoryCodeTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

DRTShieldingDeviceSequence::Item* ml::DcmDRTShieldingDeviceSequenceInterface::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 mlDcmDRTShieldingDeviceSequenceInterface.h.

MLint ml::DcmDRTShieldingDeviceSequenceInterface::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 mlDcmDRTShieldingDeviceSequenceInterface.h.

DRTShieldingDeviceSequence* ml::DcmDRTShieldingDeviceSequenceInterface::getSequence

(

)

const [inline]

Return the DRTShieldingDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTShieldingDeviceSequence

Definition at line 89 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceDescription	(	DRTShieldingDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceDescriptionTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceLabel	(	DRTShieldingDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceLabel	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceLabelTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDevicePosition	(	DRTShieldingDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDevicePosition	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDevicePositionTag

(

)

const [inline]

Definition at line 71 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceType	(	DRTShieldingDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceTypeTag

(

)

const [inline]

Definition at line 77 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTShieldingDeviceSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 95 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::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 mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::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 mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::setAccessoryCode	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTShieldingDeviceSequenceInterface::setSequence

(

DRTShieldingDeviceSequence *

dcmSequence

)

[inline]

Set the DRTShieldingDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTShieldingDeviceSequence

Definition at line 83 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDeviceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDeviceLabel	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDevicePosition	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDeviceType	(	unsigned long	idx,
		std::string &	parameter
	)

---

Member Data Documentation

DRTShieldingDeviceSequence* ml::DcmDRTShieldingDeviceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 151 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

---

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

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