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)
	Set the DRTSetupDeviceSequence this interface class provides access to.

std::vector< DcmDRTSetupDeviceSequenceInterface::Item >	getSequence () const
	Return the DRTSetupDeviceSequence this interface class provides access to.

bool	hasSequence () const
	Check if the DRTSetupDeviceSequence is set.

MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.

DcmDRTSetupDeviceSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.

DcmDRTSetupDeviceSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.

void	addItem (DcmDRTSetupDeviceSequenceInterface::Item newItem)

bool	insertItem (const size_t idx)
	Insert an item at the indicated position.

bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence.

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.

◆ DcmDRTSetupDeviceSequenceInterface() [3/3]

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

inline

Definition at line 103 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References mlrange_cast().

◆ ~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.

◆ addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTSetupDeviceSequenceInterface.h.

References mlrange_cast().

◆ 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 mlrange_cast().

◆ 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.

◆ 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.

Referenced by DRTSetupDeviceSequenceItemWrapper::DRTSetupDeviceSequenceItemWrapper(), and DRTSetupDeviceSequenceItemWrapper::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.

Referenced by DRTSetupDeviceSequenceWrapper::getSetupDeviceDescriptionTag().

◆ 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.

Referenced by DRTSetupDeviceSequenceWrapper::getSetupDeviceLabelTag().

◆ 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.

Referenced by DRTSetupDeviceSequenceWrapper::getSetupDeviceParameterTag().

◆ 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.

Referenced by DRTSetupDeviceSequenceWrapper::getSetupDeviceTypeTag().

◆ 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.

Referenced by DRTSetupDeviceSequenceWrapper::getSetupReferenceDescriptionTag().

◆ 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.

◆ 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 mlrange_cast().

◆ 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 mlrange_cast().

◆ 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 mlrange_cast().

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

◆ 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.

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

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

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTSetupDeviceSequenceInterface() [1/3]

◆ DcmDRTSetupDeviceSequenceInterface() [2/3]

◆ DcmDRTSetupDeviceSequenceInterface() [3/3]

◆ ~DcmDRTSetupDeviceSequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getItem()

◆ getNumberOfItems()

◆ getSequence()

◆ getSetupDeviceDescription() [1/2]

◆ getSetupDeviceDescription() [2/2]

◆ getSetupDeviceDescriptionTag()

◆ getSetupDeviceLabel() [1/2]

◆ getSetupDeviceLabel() [2/2]

◆ getSetupDeviceLabelTag()

◆ getSetupDeviceParameter() [1/2]

◆ getSetupDeviceParameter() [2/2]

◆ getSetupDeviceParameterTag()

◆ getSetupDeviceType() [1/2]

◆ getSetupDeviceType() [2/2]

◆ getSetupDeviceTypeTag()

◆ getSetupReferenceDescription() [1/2]

◆ getSetupReferenceDescription() [2/2]

◆ getSetupReferenceDescriptionTag()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setSequence()

◆ setSetupDeviceDescription()

◆ setSetupDeviceLabel()

◆ setSetupDeviceParameter()

◆ setSetupDeviceType()

◆ setSetupReferenceDescription()

Member Data Documentation

◆ _itemVec