ml::DcmDRTRangeShifterSequenceInterface Class Reference

Class to provide access to DRTRangeShifterSequence. More...

#include <mlDcmDRTRangeShifterSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTRangeShifterSequenceInterface (DRTRangeShifterSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTRangeShifterSequenceInterface ()
	Default virtual Destructor.
bool	getAccessoryCode (unsigned long idx, std::string &parameter)
bool	getAccessoryCode (DRTRangeShifterSequence::Item &item, std::string &parameter)
std::string	getAccessoryCodeTag () const
bool	setAccessoryCode (unsigned long idx, std::string &parameter)
bool	getRangeShifterDescription (unsigned long idx, std::string &parameter)
bool	getRangeShifterDescription (DRTRangeShifterSequence::Item &item, std::string &parameter)
std::string	getRangeShifterDescriptionTag () const
bool	setRangeShifterDescription (unsigned long idx, std::string &parameter)
bool	getRangeShifterID (unsigned long idx, std::string &parameter)
bool	getRangeShifterID (DRTRangeShifterSequence::Item &item, std::string &parameter)
std::string	getRangeShifterIDTag () const
bool	setRangeShifterID (unsigned long idx, std::string &parameter)
bool	getRangeShifterNumber (unsigned long idx, std::string &parameter)
bool	getRangeShifterNumber (DRTRangeShifterSequence::Item &item, std::string &parameter)
std::string	getRangeShifterNumberTag () const
bool	setRangeShifterNumber (unsigned long idx, std::string &parameter)
bool	getRangeShifterType (unsigned long idx, std::string &parameter)
bool	getRangeShifterType (DRTRangeShifterSequence::Item &item, std::string &parameter)
std::string	getRangeShifterTypeTag () const
bool	setRangeShifterType (unsigned long idx, std::string &parameter)
void	setSequence (DRTRangeShifterSequence *dcmSequence)
	Set the DRTRangeShifterSequence this interface class provides access to.
DRTRangeShifterSequence *	getSequence () const
	Return the DRTRangeShifterSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTRangeShifterSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTRangeShifterSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTRangeShifterSequence::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
DRTRangeShifterSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTRangeShifterSequence.

Definition at line 42 of file mlDcmDRTRangeShifterSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTRangeShifterSequenceInterface::DcmDRTRangeShifterSequenceInterface

(

DRTRangeShifterSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRangeShifterSequenceInterface.h.

virtual ml::DcmDRTRangeShifterSequenceInterface::~DcmDRTRangeShifterSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRangeShifterSequenceInterface.h.

---

Member Function Documentation

DRTRangeShifterSequence::Item* ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::getAccessoryCode	(	DRTRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTRangeShifterSequenceInterface::getAccessoryCodeTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTRangeShifterSequenceInterface.h.

DRTRangeShifterSequence::Item* ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

MLint ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterDescription	(	DRTRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterDescriptionTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterID	(	DRTRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterIDTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterNumber	(	DRTRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterNumberTag

(

)

const [inline]

Definition at line 71 of file mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterType	(	DRTRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterTypeTag

(

)

const [inline]

Definition at line 77 of file mlDcmDRTRangeShifterSequenceInterface.h.

DRTRangeShifterSequence* ml::DcmDRTRangeShifterSequenceInterface::getSequence

(

)

const [inline]

Return the DRTRangeShifterSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRangeShifterSequence

Definition at line 89 of file mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTRangeShifterSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 95 of file mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

bool ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

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

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterID	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterNumber	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterType	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTRangeShifterSequenceInterface::setSequence

(

DRTRangeShifterSequence *

dcmSequence

)

[inline]

Set the DRTRangeShifterSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRangeShifterSequence

Definition at line 83 of file mlDcmDRTRangeShifterSequenceInterface.h.

---

Member Data Documentation

DRTRangeShifterSequence* ml::DcmDRTRangeShifterSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 151 of file mlDcmDRTRangeShifterSequenceInterface.h.

---

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

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