Class to provide access to DRTModalityLUTSequence. More...

#include <mlDcmDRTModalityLUTSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTModalityLUTSequenceInterface ()
	DcmDRTModalityLUTSequenceInterface (std::vector< DcmDRTModalityLUTSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTModalityLUTSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTModalityLUTSequenceInterface ()
	Default virtual Destructor.
bool	getLUTDescriptor (unsigned long idx, MLuint16 &parameter) const
bool	getLUTDescriptor (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string	getLUTDescriptorTag () const
bool	setLUTDescriptor (unsigned long idx, MLuint16 parameter)
bool	getLUTExplanation (unsigned long idx, std::string &parameter) const
bool	getLUTExplanation (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLUTExplanationTag () const
bool	setLUTExplanation (unsigned long idx, std::string parameter)
bool	getModalityLUTType (unsigned long idx, std::string &parameter) const
bool	getModalityLUTType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getModalityLUTTypeTag () const
bool	setModalityLUTType (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTModalityLUTSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTModalityLUTSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTModalityLUTSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTModalityLUTSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTModalityLUTSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTModalityLUTSequence.

Definition at line 43 of file mlDcmDRTModalityLUTSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTModalityLUTSequenceInterface() [1/3]

ml::DcmDRTModalityLUTSequenceInterface::DcmDRTModalityLUTSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTModalityLUTSequenceInterface.h.

◆ DcmDRTModalityLUTSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ DcmDRTModalityLUTSequenceInterface() [3/3]

ml::DcmDRTModalityLUTSequenceInterface::DcmDRTModalityLUTSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTModalityLUTSequenceInterface()

virtual ml::DcmDRTModalityLUTSequenceInterface::~DcmDRTModalityLUTSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTModalityLUTSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTModalityLUTSequenceInterface::Item & ml::DcmDRTModalityLUTSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns: Return the new item which has been added to the sequence

Definition at line 156 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ getItem()

DcmDRTModalityLUTSequenceInterface::Item ml::DcmDRTModalityLUTSequenceInterface::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 147 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ getLUTDescriptor() [1/2]

bool ml::DcmDRTModalityLUTSequenceInterface::getLUTDescriptor	(	DCMTree::TreePtr	item,
		MLuint16 &	parameter ) const

◆ getLUTDescriptor() [2/2]

bool ml::DcmDRTModalityLUTSequenceInterface::getLUTDescriptor	(	unsigned long	idx,
		MLuint16 &	parameter ) const

◆ getLUTDescriptorTag()

std::string ml::DcmDRTModalityLUTSequenceInterface::getLUTDescriptorTag ( ) const

inline

Definition at line 105 of file mlDcmDRTModalityLUTSequenceInterface.h.

◆ getLUTExplanation() [1/2]

bool ml::DcmDRTModalityLUTSequenceInterface::getLUTExplanation	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getLUTExplanation() [2/2]

bool ml::DcmDRTModalityLUTSequenceInterface::getLUTExplanation	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getLUTExplanationTag()

std::string ml::DcmDRTModalityLUTSequenceInterface::getLUTExplanationTag ( ) const

inline

Definition at line 111 of file mlDcmDRTModalityLUTSequenceInterface.h.

◆ getModalityLUTType() [1/2]

bool ml::DcmDRTModalityLUTSequenceInterface::getModalityLUTType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getModalityLUTType() [2/2]

bool ml::DcmDRTModalityLUTSequenceInterface::getModalityLUTType	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getModalityLUTTypeTag()

std::string ml::DcmDRTModalityLUTSequenceInterface::getModalityLUTTypeTag ( ) const

inline

Definition at line 117 of file mlDcmDRTModalityLUTSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTModalityLUTSequenceInterface::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 141 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ getSequence()

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

inline

Return the DRTModalityLUTSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTModalityLUTSequence

Definition at line 129 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

bool ml::DcmDRTModalityLUTSequenceInterface::hasSequence ( ) const

inline

Check if the DRTModalityLUTSequence is set.

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

Definition at line 135 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTModalityLUTSequenceInterface::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 167 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTModalityLUTSequenceInterface::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 179 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

◆ setLUTDescriptor()

bool ml::DcmDRTModalityLUTSequenceInterface::setLUTDescriptor	(	unsigned long	idx,
		MLuint16	parameter )

◆ setLUTExplanation()

bool ml::DcmDRTModalityLUTSequenceInterface::setLUTExplanation	(	unsigned long	idx,
		std::string	parameter )

◆ setModalityLUTType()

bool ml::DcmDRTModalityLUTSequenceInterface::setModalityLUTType	(	unsigned long	idx,
		std::string	parameter )

◆ setSequence()

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

inline

Set the DRTModalityLUTSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTModalityLUTSequence

Definition at line 123 of file mlDcmDRTModalityLUTSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTModalityLUTSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTModalityLUTSequenceInterface(), DcmDRTModalityLUTSequenceInterface(), 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/mlDcmDRTModalityLUTSequenceInterface.h

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTModalityLUTSequenceInterface() [1/3]

◆ DcmDRTModalityLUTSequenceInterface() [2/3]

◆ DcmDRTModalityLUTSequenceInterface() [3/3]

◆ ~DcmDRTModalityLUTSequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getItem()

◆ getLUTDescriptor() [1/2]

◆ getLUTDescriptor() [2/2]

◆ getLUTDescriptorTag()

◆ getLUTExplanation() [1/2]

◆ getLUTExplanation() [2/2]

◆ getLUTExplanationTag()

◆ getModalityLUTType() [1/2]

◆ getModalityLUTType() [2/2]

◆ getModalityLUTTypeTag()

◆ getNumberOfItems()

◆ getSequence()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setLUTDescriptor()

◆ setLUTExplanation()

◆ setModalityLUTType()

◆ setSequence()

Member Data Documentation

◆ _itemVec