ml::DcmDRTDeviceSequenceInterface Class Reference

Class to provide access to DRTDeviceSequence. More...

#include <mlDcmDRTDeviceSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTDeviceSequenceInterface (DRTDeviceSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTDeviceSequenceInterface ()
	Default virtual Destructor.
bool	getCodeMeaning (unsigned long idx, std::string &parameter)
bool	getCodeMeaning (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getCodeMeaningTag () const
bool	setCodeMeaning (unsigned long idx, std::string &parameter)
bool	getCodeValue (unsigned long idx, std::string &parameter)
bool	getCodeValue (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getCodeValueTag () const
bool	setCodeValue (unsigned long idx, std::string &parameter)
bool	getCodingSchemeDesignator (unsigned long idx, std::string &parameter)
bool	getCodingSchemeDesignator (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getCodingSchemeDesignatorTag () const
bool	setCodingSchemeDesignator (unsigned long idx, std::string &parameter)
bool	getCodingSchemeVersion (unsigned long idx, std::string &parameter)
bool	getCodingSchemeVersion (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getCodingSchemeVersionTag () const
bool	setCodingSchemeVersion (unsigned long idx, std::string &parameter)
bool	getContextGroupExtensionCreatorUID (unsigned long idx, std::string &parameter)
bool	getContextGroupExtensionCreatorUID (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getContextGroupExtensionCreatorUIDTag () const
bool	setContextGroupExtensionCreatorUID (unsigned long idx, std::string &parameter)
bool	getContextGroupExtensionFlag (unsigned long idx, std::string &parameter)
bool	getContextGroupExtensionFlag (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getContextGroupExtensionFlagTag () const
bool	setContextGroupExtensionFlag (unsigned long idx, std::string &parameter)
bool	getContextGroupLocalVersion (unsigned long idx, std::string &parameter)
bool	getContextGroupLocalVersion (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getContextGroupLocalVersionTag () const
bool	setContextGroupLocalVersion (unsigned long idx, std::string &parameter)
bool	getContextGroupVersion (unsigned long idx, std::string &parameter)
bool	getContextGroupVersion (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getContextGroupVersionTag () const
bool	setContextGroupVersion (unsigned long idx, std::string &parameter)
bool	getContextIdentifier (unsigned long idx, std::string &parameter)
bool	getContextIdentifier (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getContextIdentifierTag () const
bool	setContextIdentifier (unsigned long idx, std::string &parameter)
bool	getDeviceDescription (unsigned long idx, std::string &parameter)
bool	getDeviceDescription (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getDeviceDescriptionTag () const
bool	setDeviceDescription (unsigned long idx, std::string &parameter)
bool	getDeviceDiameter (unsigned long idx, std::string &parameter)
bool	getDeviceDiameter (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getDeviceDiameterTag () const
bool	setDeviceDiameter (unsigned long idx, std::string &parameter)
bool	getDeviceDiameterUnits (unsigned long idx, std::string &parameter)
bool	getDeviceDiameterUnits (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getDeviceDiameterUnitsTag () const
bool	setDeviceDiameterUnits (unsigned long idx, std::string &parameter)
bool	getDeviceID (unsigned long idx, std::string &parameter)
bool	getDeviceID (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getDeviceIDTag () const
bool	setDeviceID (unsigned long idx, std::string &parameter)
bool	getDeviceLength (unsigned long idx, std::string &parameter)
bool	getDeviceLength (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getDeviceLengthTag () const
bool	setDeviceLength (unsigned long idx, std::string &parameter)
bool	getDeviceSerialNumber (unsigned long idx, std::string &parameter)
bool	getDeviceSerialNumber (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getDeviceSerialNumberTag () const
bool	setDeviceSerialNumber (unsigned long idx, std::string &parameter)
bool	getDeviceVolume (unsigned long idx, std::string &parameter)
bool	getDeviceVolume (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getDeviceVolumeTag () const
bool	setDeviceVolume (unsigned long idx, std::string &parameter)
bool	getInterMarkerDistance (unsigned long idx, std::string &parameter)
bool	getInterMarkerDistance (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getInterMarkerDistanceTag () const
bool	setInterMarkerDistance (unsigned long idx, std::string &parameter)
bool	getManufacturer (unsigned long idx, std::string &parameter)
bool	getManufacturer (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getManufacturerTag () const
bool	setManufacturer (unsigned long idx, std::string &parameter)
bool	getManufacturerModelName (unsigned long idx, std::string &parameter)
bool	getManufacturerModelName (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getManufacturerModelNameTag () const
bool	setManufacturerModelName (unsigned long idx, std::string &parameter)
bool	getMappingResource (unsigned long idx, std::string &parameter)
bool	getMappingResource (DRTDeviceSequence::Item &item, std::string &parameter)
std::string	getMappingResourceTag () const
bool	setMappingResource (unsigned long idx, std::string &parameter)
void	setSequence (DRTDeviceSequence *dcmSequence)
	Set the DRTDeviceSequence this interface class provides access to.
DRTDeviceSequence *	getSequence () const
	Return the DRTDeviceSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTDeviceSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTDeviceSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTDeviceSequence::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
DRTDeviceSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTDeviceSequence.

Definition at line 42 of file mlDcmDRTDeviceSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTDeviceSequenceInterface::DcmDRTDeviceSequenceInterface

(

DRTDeviceSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 46 of file mlDcmDRTDeviceSequenceInterface.h.

virtual ml::DcmDRTDeviceSequenceInterface::~DcmDRTDeviceSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 49 of file mlDcmDRTDeviceSequenceInterface.h.

---

Member Function Documentation

DRTDeviceSequence::Item* ml::DcmDRTDeviceSequenceInterface::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 209 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getCodeMeaning	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getCodeMeaning	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getCodeMeaningTag

(

)

const [inline]

Definition at line 53 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getCodeValue	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getCodeValue	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getCodeValueTag

(

)

const [inline]

Definition at line 59 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getCodingSchemeDesignator	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getCodingSchemeDesignator	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getCodingSchemeDesignatorTag

(

)

const [inline]

Definition at line 65 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getCodingSchemeVersion	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getCodingSchemeVersion	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getCodingSchemeVersionTag

(

)

const [inline]

Definition at line 71 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupExtensionCreatorUID	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupExtensionCreatorUID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getContextGroupExtensionCreatorUIDTag

(

)

const [inline]

Definition at line 77 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupExtensionFlag	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupExtensionFlag	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getContextGroupExtensionFlagTag

(

)

const [inline]

Definition at line 83 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupLocalVersion	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupLocalVersion	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getContextGroupLocalVersionTag

(

)

const [inline]

Definition at line 89 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupVersion	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getContextGroupVersion	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getContextGroupVersionTag

(

)

const [inline]

Definition at line 95 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getContextIdentifier	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getContextIdentifier	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getContextIdentifierTag

(

)

const [inline]

Definition at line 101 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getDeviceDescription	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getDeviceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getDeviceDescriptionTag

(

)

const [inline]

Definition at line 107 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getDeviceDiameter	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getDeviceDiameter	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getDeviceDiameterTag

(

)

const [inline]

Definition at line 113 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getDeviceDiameterUnits	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getDeviceDiameterUnits	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getDeviceDiameterUnitsTag

(

)

const [inline]

Definition at line 119 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getDeviceID	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getDeviceID	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getDeviceIDTag

(

)

const [inline]

Definition at line 125 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getDeviceLength	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getDeviceLength	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getDeviceLengthTag

(

)

const [inline]

Definition at line 131 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getDeviceSerialNumber	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getDeviceSerialNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getDeviceSerialNumberTag

(

)

const [inline]

Definition at line 137 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getDeviceVolume	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getDeviceVolume	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getDeviceVolumeTag

(

)

const [inline]

Definition at line 143 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getInterMarkerDistance	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getInterMarkerDistance	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getInterMarkerDistanceTag

(

)

const [inline]

Definition at line 149 of file mlDcmDRTDeviceSequenceInterface.h.

DRTDeviceSequence::Item* ml::DcmDRTDeviceSequenceInterface::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 200 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getManufacturer	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getManufacturer	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getManufacturerModelName	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getManufacturerModelName	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getManufacturerModelNameTag

(

)

const [inline]

Definition at line 161 of file mlDcmDRTDeviceSequenceInterface.h.

std::string ml::DcmDRTDeviceSequenceInterface::getManufacturerTag

(

)

const [inline]

Definition at line 155 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::getMappingResource	(	DRTDeviceSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::getMappingResource	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTDeviceSequenceInterface::getMappingResourceTag

(

)

const [inline]

Definition at line 167 of file mlDcmDRTDeviceSequenceInterface.h.

MLint ml::DcmDRTDeviceSequenceInterface::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 191 of file mlDcmDRTDeviceSequenceInterface.h.

DRTDeviceSequence* ml::DcmDRTDeviceSequenceInterface::getSequence

(

)

const [inline]

Return the DRTDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTDeviceSequence

Definition at line 179 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTDeviceSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 185 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::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 220 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::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 231 of file mlDcmDRTDeviceSequenceInterface.h.

bool ml::DcmDRTDeviceSequenceInterface::setCodeMeaning	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setCodeValue	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setCodingSchemeDesignator	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setCodingSchemeVersion	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setContextGroupExtensionCreatorUID	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setContextGroupExtensionFlag	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setContextGroupLocalVersion	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setContextGroupVersion	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setContextIdentifier	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setDeviceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setDeviceDiameter	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setDeviceDiameterUnits	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setDeviceID	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setDeviceLength	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setDeviceSerialNumber	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setDeviceVolume	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setInterMarkerDistance	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setManufacturer	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setManufacturerModelName	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTDeviceSequenceInterface::setMappingResource	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTDeviceSequenceInterface::setSequence

(

DRTDeviceSequence *

dcmSequence

)

[inline]

Set the DRTDeviceSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTDeviceSequence

Definition at line 173 of file mlDcmDRTDeviceSequenceInterface.h.

---

Member Data Documentation

DRTDeviceSequence* ml::DcmDRTDeviceSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 241 of file mlDcmDRTDeviceSequenceInterface.h.

---

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

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