ml::DcmDRTRecordedCompensatorSequenceInterface Class Reference

Class to provide access to DRTRecordedCompensatorSequence. More...

#include <mlDcmDRTRecordedCompensatorSequenceInterface.h>

List of all members.

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

---

Detailed Description

Class to provide access to DRTRecordedCompensatorSequence.

Definition at line 42 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTRecordedCompensatorSequenceInterface::DcmDRTRecordedCompensatorSequenceInterface

(

DRTRecordedCompensatorSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

virtual ml::DcmDRTRecordedCompensatorSequenceInterface::~DcmDRTRecordedCompensatorSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

---

Member Function Documentation

DRTRecordedCompensatorSequence::Item* ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getAccessoryCode	(	DRTRecordedCompensatorSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTRecordedCompensatorSequenceInterface::getAccessoryCodeTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getCompensatorID	(	DRTRecordedCompensatorSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getCompensatorID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRecordedCompensatorSequenceInterface::getCompensatorIDTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

DRTRecordedCompensatorSequence::Item* ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

MLint ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getReferencedCompensatorNumber	(	DRTRecordedCompensatorSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getReferencedCompensatorNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTRecordedCompensatorSequenceInterface::getReferencedCompensatorNumberTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

DRTRecordedCompensatorSequence* ml::DcmDRTRecordedCompensatorSequenceInterface::getSequence

(

)

const [inline]

Return the DRTRecordedCompensatorSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRecordedCompensatorSequence

Definition at line 77 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

bool ml::DcmDRTRecordedCompensatorSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTRecordedCompensatorSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 83 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

bool ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

bool ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

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

bool ml::DcmDRTRecordedCompensatorSequenceInterface::setCompensatorID	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTRecordedCompensatorSequenceInterface::setReferencedCompensatorNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTRecordedCompensatorSequenceInterface::setSequence

(

DRTRecordedCompensatorSequence *

dcmSequence

)

[inline]

Set the DRTRecordedCompensatorSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTRecordedCompensatorSequence

Definition at line 71 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

---

Member Data Documentation

DRTRecordedCompensatorSequence* ml::DcmDRTRecordedCompensatorSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 139 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

---

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

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