Class to provide access to DRTReferencedSetupImageSequence. More...

#include <mlDcmDRTReferencedSetupImageSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTReferencedSetupImageSequenceInterface ()

	DcmDRTReferencedSetupImageSequenceInterface (std::vector< DcmDRTReferencedSetupImageSequenceInterface::Item > dcmSequence)
	Default Constructor.

	DcmDRTReferencedSetupImageSequenceInterface (DCMTree::TreePtrVector treePtrSeq)

virtual	~DcmDRTReferencedSetupImageSequenceInterface ()
	Default virtual Destructor.

bool	getReferencedFrameNumber (unsigned long idx, std::string &parameter) const

bool	getReferencedFrameNumber (DCMTree::TreePtr item, std::string &parameter) const

std::string	getReferencedFrameNumberTag () const

bool	setReferencedFrameNumber (unsigned long idx, std::string parameter)

bool	getReferencedSOPClassUID (unsigned long idx, std::string &parameter) const

bool	getReferencedSOPClassUID (DCMTree::TreePtr item, std::string &parameter) const

std::string	getReferencedSOPClassUIDTag () const

bool	setReferencedSOPClassUID (unsigned long idx, std::string parameter)

bool	getReferencedSOPInstanceUID (unsigned long idx, std::string &parameter) const

bool	getReferencedSOPInstanceUID (DCMTree::TreePtr item, std::string &parameter) const

std::string	getReferencedSOPInstanceUIDTag () const

bool	setReferencedSOPInstanceUID (unsigned long idx, std::string parameter)

bool	getReferencedSegmentNumber (unsigned long idx, MLuint16 &parameter) const

bool	getReferencedSegmentNumber (DCMTree::TreePtr item, MLuint16 &parameter) const

std::string	getReferencedSegmentNumberTag () const

bool	setReferencedSegmentNumber (unsigned long idx, MLuint16 parameter)

bool	getSetupImageComment (unsigned long idx, std::string &parameter) const

bool	getSetupImageComment (DCMTree::TreePtr item, std::string &parameter) const

std::string	getSetupImageCommentTag () const

bool	setSetupImageComment (unsigned long idx, std::string parameter)

void	setSequence (std::vector< DcmDRTReferencedSetupImageSequenceInterface::Item > dcmSequence)
	Set the DRTReferencedSetupImageSequence this interface class provides access to.

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

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

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

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

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

void	addItem (DcmDRTReferencedSetupImageSequenceInterface::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< DcmDRTReferencedSetupImageSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTReferencedSetupImageSequence.

Definition at line 43 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTReferencedSetupImageSequenceInterface() [1/3]

ml::DcmDRTReferencedSetupImageSequenceInterface::DcmDRTReferencedSetupImageSequenceInterface ( )

inline

Definition at line 98 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

◆ DcmDRTReferencedSetupImageSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 101 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

◆ DcmDRTReferencedSetupImageSequenceInterface() [3/3]

ml::DcmDRTReferencedSetupImageSequenceInterface::DcmDRTReferencedSetupImageSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 103 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

References mlrange_cast().

◆ ~DcmDRTReferencedSetupImageSequenceInterface()

virtual ml::DcmDRTReferencedSetupImageSequenceInterface::~DcmDRTReferencedSetupImageSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTReferencedSetupImageSequenceInterface::Item & ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

◆ addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

References mlrange_cast().

◆ getItem()

DcmDRTReferencedSetupImageSequenceInterface::Item ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

References mlrange_cast().

◆ getNumberOfItems()

MLint ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

◆ getReferencedFrameNumber() [1/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedFrameNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getReferencedFrameNumber() [2/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedFrameNumber	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getReferencedFrameNumberTag()

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedFrameNumberTag ( ) const

inline

Definition at line 115 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Referenced by DRTReferencedSetupImageSequenceWrapper::getReferencedFrameNumberTag().

◆ getReferencedSegmentNumber() [1/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSegmentNumber	(	DCMTree::TreePtr	item,
		MLuint16 &	parameter ) const

◆ getReferencedSegmentNumber() [2/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSegmentNumber	(	unsigned long	idx,
		MLuint16 &	parameter ) const

◆ getReferencedSegmentNumberTag()

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSegmentNumberTag ( ) const

inline

Definition at line 133 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Referenced by DRTReferencedSetupImageSequenceWrapper::getReferencedSegmentNumberTag().

◆ getReferencedSOPClassUID() [1/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPClassUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getReferencedSOPClassUID() [2/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPClassUID	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getReferencedSOPClassUIDTag()

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPClassUIDTag ( ) const

inline

Definition at line 121 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Referenced by DRTReferencedSetupImageSequenceWrapper::getReferencedSOPClassUIDTag().

◆ getReferencedSOPInstanceUID() [1/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPInstanceUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getReferencedSOPInstanceUID() [2/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getReferencedSOPInstanceUIDTag()

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getReferencedSOPInstanceUIDTag ( ) const

inline

Definition at line 127 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Referenced by DRTReferencedSetupImageSequenceWrapper::getReferencedSOPInstanceUIDTag().

◆ getSequence()

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

inline

Return the DRTReferencedSetupImageSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTReferencedSetupImageSequence

Definition at line 151 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

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

◆ getSetupImageComment() [1/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getSetupImageComment	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getSetupImageComment() [2/2]

bool ml::DcmDRTReferencedSetupImageSequenceInterface::getSetupImageComment	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getSetupImageCommentTag()

std::string ml::DcmDRTReferencedSetupImageSequenceInterface::getSetupImageCommentTag ( ) const

inline

Definition at line 139 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

Referenced by DRTReferencedSetupImageSequenceWrapper::getSetupImageCommentTag().

◆ hasSequence()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::hasSequence ( ) const

inline

Check if the DRTReferencedSetupImageSequence is set.

Returns: True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

References mlrange_cast().

◆ removeItem()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::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 mlDcmDRTReferencedSetupImageSequenceInterface.h.

References mlrange_cast().

◆ setReferencedFrameNumber()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedFrameNumber	(	unsigned long	idx,
		std::string	parameter )

◆ setReferencedSegmentNumber()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedSegmentNumber	(	unsigned long	idx,
		MLuint16	parameter )

◆ setReferencedSOPClassUID()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedSOPClassUID	(	unsigned long	idx,
		std::string	parameter )

◆ setReferencedSOPInstanceUID()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setReferencedSOPInstanceUID	(	unsigned long	idx,
		std::string	parameter )

◆ setSequence()

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

inline

Set the DRTReferencedSetupImageSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTReferencedSetupImageSequence

Definition at line 145 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

References mlrange_cast().

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

◆ setSetupImageComment()

bool ml::DcmDRTReferencedSetupImageSequenceInterface::setSetupImageComment	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

◆ _itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTReferencedSetupImageSequenceInterface.h.

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

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

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTReferencedSetupImageSequenceInterface() [1/3]

◆ DcmDRTReferencedSetupImageSequenceInterface() [2/3]

◆ DcmDRTReferencedSetupImageSequenceInterface() [3/3]

◆ ~DcmDRTReferencedSetupImageSequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getItem()

◆ getNumberOfItems()

◆ getReferencedFrameNumber() [1/2]

◆ getReferencedFrameNumber() [2/2]

◆ getReferencedFrameNumberTag()

◆ getReferencedSegmentNumber() [1/2]

◆ getReferencedSegmentNumber() [2/2]

◆ getReferencedSegmentNumberTag()

◆ getReferencedSOPClassUID() [1/2]

◆ getReferencedSOPClassUID() [2/2]

◆ getReferencedSOPClassUIDTag()

◆ getReferencedSOPInstanceUID() [1/2]

◆ getReferencedSOPInstanceUID() [2/2]

◆ getReferencedSOPInstanceUIDTag()

◆ getSequence()

◆ getSetupImageComment() [1/2]

◆ getSetupImageComment() [2/2]

◆ getSetupImageCommentTag()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setReferencedFrameNumber()

◆ setReferencedSegmentNumber()

◆ setReferencedSOPClassUID()

◆ setReferencedSOPInstanceUID()

◆ setSequence()

◆ setSetupImageComment()

Member Data Documentation

◆ _itemVec