ml::DcmDRTSetupDeviceSequenceInterface Class Reference

Class to provide access to DRTSetupDeviceSequence. More...

#include <mlDcmDRTSetupDeviceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTSetupDeviceSequenceInterface ()
	DcmDRTSetupDeviceSequenceInterface (std::vector< DcmDRTSetupDeviceSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTSetupDeviceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTSetupDeviceSequenceInterface ()
	Default virtual Destructor.
bool	getSetupDeviceDescription (unsigned long idx, std::string &parameter) const
bool	getSetupDeviceDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSetupDeviceDescriptionTag () const
bool	setSetupDeviceDescription (unsigned long idx, std::string parameter)
bool	getSetupDeviceLabel (unsigned long idx, std::string &parameter) const
bool	getSetupDeviceLabel (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSetupDeviceLabelTag () const
bool	setSetupDeviceLabel (unsigned long idx, std::string parameter)
bool	getSetupDeviceParameter (unsigned long idx, std::string &parameter) const
bool	getSetupDeviceParameter (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSetupDeviceParameterTag () const
bool	setSetupDeviceParameter (unsigned long idx, std::string parameter)
bool	getSetupDeviceType (unsigned long idx, std::string &parameter) const
bool	getSetupDeviceType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSetupDeviceTypeTag () const
bool	setSetupDeviceType (unsigned long idx, std::string parameter)
bool	getSetupReferenceDescription (unsigned long idx, std::string &parameter) const
bool	getSetupReferenceDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSetupReferenceDescriptionTag () const
bool	setSetupReferenceDescription (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTSetupDeviceSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTSetupDeviceSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTSetupDeviceSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTSetupDeviceSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTSetupDeviceSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

Protected Attributes
std::vector< DcmDRTSetupDeviceSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTSetupDeviceSequence.

Definition at line 43 of file mlDcmDRTSetupDeviceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTSetupDeviceSequenceInterface() [1/3]

ml::DcmDRTSetupDeviceSequenceInterface::DcmDRTSetupDeviceSequenceInterface ( )

inline

Definition at line 98 of file mlDcmDRTSetupDeviceSequenceInterface.h.

DcmDRTSetupDeviceSequenceInterface() [2/3]

ml::DcmDRTSetupDeviceSequenceInterface::DcmDRTSetupDeviceSequenceInterface ( std::vector< DcmDRTSetupDeviceSequenceInterface::Item > dcmSequence )

inline

Default Constructor.

Definition at line 101 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

DcmDRTSetupDeviceSequenceInterface() [3/3]

ml::DcmDRTSetupDeviceSequenceInterface::DcmDRTSetupDeviceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 103 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

~DcmDRTSetupDeviceSequenceInterface()

virtual ml::DcmDRTSetupDeviceSequenceInterface::~DcmDRTSetupDeviceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTSetupDeviceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTSetupDeviceSequenceInterface::Item & ml::DcmDRTSetupDeviceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 178 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

addItem() [2/2]

void ml::DcmDRTSetupDeviceSequenceInterface::addItem ( DcmDRTSetupDeviceSequenceInterface::Item newItem )

inline

Definition at line 183 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

getItem()

DcmDRTSetupDeviceSequenceInterface::Item ml::DcmDRTSetupDeviceSequenceInterface::getItem ( const size_t idx ) const

inline

Gets the item at the indicated position.

Returns

The requested item, an empty item when the position is invalid

Definition at line 169 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTSetupDeviceSequenceInterface::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 163 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

getSequence()

std::vector< DcmDRTSetupDeviceSequenceInterface::Item > ml::DcmDRTSetupDeviceSequenceInterface::getSequence ( ) const

inline

Return the DRTSetupDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSetupDeviceSequence

Definition at line 151 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

Referenced by DRTSetupDeviceSequenceWrapper::DRTSetupDeviceSequenceWrapper(), and DRTSetupDeviceSequenceWrapper::operator=().

getSetupDeviceDescription() [1/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSetupDeviceDescription() [2/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getSetupDeviceDescriptionTag()

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceDescriptionTag ( ) const

inline

Definition at line 115 of file mlDcmDRTSetupDeviceSequenceInterface.h.

getSetupDeviceLabel() [1/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceLabel	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSetupDeviceLabel() [2/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceLabel	(	unsigned long	idx,
		std::string &	parameter ) const

getSetupDeviceLabelTag()

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceLabelTag ( ) const

inline

Definition at line 121 of file mlDcmDRTSetupDeviceSequenceInterface.h.

getSetupDeviceParameter() [1/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceParameter	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSetupDeviceParameter() [2/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceParameter	(	unsigned long	idx,
		std::string &	parameter ) const

getSetupDeviceParameterTag()

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceParameterTag ( ) const

inline

Definition at line 127 of file mlDcmDRTSetupDeviceSequenceInterface.h.

getSetupDeviceType() [1/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSetupDeviceType() [2/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceType	(	unsigned long	idx,
		std::string &	parameter ) const

getSetupDeviceTypeTag()

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupDeviceTypeTag ( ) const

inline

Definition at line 133 of file mlDcmDRTSetupDeviceSequenceInterface.h.

getSetupReferenceDescription() [1/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupReferenceDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSetupReferenceDescription() [2/2]

bool ml::DcmDRTSetupDeviceSequenceInterface::getSetupReferenceDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getSetupReferenceDescriptionTag()

std::string ml::DcmDRTSetupDeviceSequenceInterface::getSetupReferenceDescriptionTag ( ) const

inline

Definition at line 139 of file mlDcmDRTSetupDeviceSequenceInterface.h.

hasSequence()

bool ml::DcmDRTSetupDeviceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTSetupDeviceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTSetupDeviceSequenceInterface::insertItem ( const size_t idx )

inline

Insert an item at the indicated position

Returns

true is the insertion was successful, false if position is invalid

Definition at line 189 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTSetupDeviceSequenceInterface::removeItem ( const size_t idx )

inline

Removes the indicated item from the sequence

Returns

true if the item was deleted successfully, false if the indicated position is invalid

Definition at line 201 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

setSequence()

void ml::DcmDRTSetupDeviceSequenceInterface::setSequence ( std::vector< DcmDRTSetupDeviceSequenceInterface::Item > dcmSequence )

inline

Set the DRTSetupDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSetupDeviceSequence

Definition at line 145 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References _itemVec.

setSetupDeviceDescription()

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceDescription	(	unsigned long	idx,
		std::string	parameter )

setSetupDeviceLabel()

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceLabel	(	unsigned long	idx,
		std::string	parameter )

setSetupDeviceParameter()

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceParameter	(	unsigned long	idx,
		std::string	parameter )

setSetupDeviceType()

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupDeviceType	(	unsigned long	idx,
		std::string	parameter )

setSetupReferenceDescription()

bool ml::DcmDRTSetupDeviceSequenceInterface::setSetupReferenceDescription	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

std::vector<DcmDRTSetupDeviceSequenceInterface::Item> ml::DcmDRTSetupDeviceSequenceInterface::_itemVec

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTSetupDeviceSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTSetupDeviceSequenceInterface(), DcmDRTSetupDeviceSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

---

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

• FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTSetupDeviceSequenceInterface.h