ml::DcmDRTRecordedRangeShifterSequenceInterface Class Reference

Class to provide access to DRTRecordedRangeShifterSequence. More...

#include <mlDcmDRTRecordedRangeShifterSequenceInterface.h>

List of all members.

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

---

Detailed Description

Class to provide access to DRTRecordedRangeShifterSequence.

Definition at line 42 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTRecordedRangeShifterSequenceInterface::DcmDRTRecordedRangeShifterSequenceInterface

(

DRTRecordedRangeShifterSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

virtual ml::DcmDRTRecordedRangeShifterSequenceInterface::~DcmDRTRecordedRangeShifterSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

---

Member Function Documentation

DRTRecordedRangeShifterSequence::Item* ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getAccessoryCode	(	DRTRecordedRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTRecordedRangeShifterSequenceInterface::getAccessoryCodeTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

DRTRecordedRangeShifterSequence::Item* ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

MLint ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getRangeShifterID	(	DRTRecordedRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTRecordedRangeShifterSequenceInterface::getRangeShifterIDTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getReferencedRangeShifterNumber	(	DRTRecordedRangeShifterSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getReferencedRangeShifterNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRecordedRangeShifterSequenceInterface::getReferencedRangeShifterNumberTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

DRTRecordedRangeShifterSequence* ml::DcmDRTRecordedRangeShifterSequenceInterface::getSequence

(

)

const [inline]

Return the DRTRecordedRangeShifterSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRecordedRangeShifterSequence

Definition at line 77 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTRecordedRangeShifterSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 83 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

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

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

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::setReferencedRangeShifterNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTRecordedRangeShifterSequenceInterface::setSequence

(

DRTRecordedRangeShifterSequence *

dcmSequence

)

[inline]

Set the DRTRecordedRangeShifterSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRecordedRangeShifterSequence

Definition at line 71 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

---

Member Data Documentation

DRTRecordedRangeShifterSequence* ml::DcmDRTRecordedRangeShifterSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 139 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

---

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

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