ml::DcmDRTVOILUTSequenceInterface Class Reference

Class to provide access to DRTVOILUTSequence. More...

#include <mlDcmDRTVOILUTSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTVOILUTSequenceInterface ()
	DcmDRTVOILUTSequenceInterface (std::vector< DcmDRTVOILUTSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTVOILUTSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTVOILUTSequenceInterface ()
	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)
void	setSequence (std::vector< DcmDRTVOILUTSequenceInterface::Item > dcmSequence)
	Set the DRTVOILUTSequence this interface class provides access to.
std::vector< DcmDRTVOILUTSequenceInterface::Item >	getSequence () const
	Return the DRTVOILUTSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTVOILUTSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTVOILUTSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTVOILUTSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTVOILUTSequenceInterface::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< DcmDRTVOILUTSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTVOILUTSequence.

Definition at line 43 of file mlDcmDRTVOILUTSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTVOILUTSequenceInterface() [1/3]

ml::DcmDRTVOILUTSequenceInterface::DcmDRTVOILUTSequenceInterface ( )

inline

Definition at line 83 of file mlDcmDRTVOILUTSequenceInterface.h.

DcmDRTVOILUTSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTVOILUTSequenceInterface.h.

DcmDRTVOILUTSequenceInterface() [3/3]

ml::DcmDRTVOILUTSequenceInterface::DcmDRTVOILUTSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTVOILUTSequenceInterface.h.

~DcmDRTVOILUTSequenceInterface()

virtual ml::DcmDRTVOILUTSequenceInterface::~DcmDRTVOILUTSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTVOILUTSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTVOILUTSequenceInterface::Item & ml::DcmDRTVOILUTSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 145 of file mlDcmDRTVOILUTSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTVOILUTSequenceInterface.h.

getItem()

DcmDRTVOILUTSequenceInterface::Item ml::DcmDRTVOILUTSequenceInterface::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 136 of file mlDcmDRTVOILUTSequenceInterface.h.

getLUTDescriptor() [1/2]

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

getLUTDescriptor() [2/2]

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

getLUTDescriptorTag()

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

inline

Definition at line 100 of file mlDcmDRTVOILUTSequenceInterface.h.

Referenced by DRTVOILUTSequenceWrapper::getLUTDescriptorTag().

getLUTExplanation() [1/2]

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

getLUTExplanation() [2/2]

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

getLUTExplanationTag()

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

inline

Definition at line 106 of file mlDcmDRTVOILUTSequenceInterface.h.

Referenced by DRTVOILUTSequenceWrapper::getLUTExplanationTag().

getNumberOfItems()

MLint ml::DcmDRTVOILUTSequenceInterface::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 130 of file mlDcmDRTVOILUTSequenceInterface.h.

getSequence()

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

inline

Return the DRTVOILUTSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTVOILUTSequence

Definition at line 118 of file mlDcmDRTVOILUTSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTVOILUTSequenceInterface::hasSequence ( ) const

inline

Check if the DRTVOILUTSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTVOILUTSequenceInterface.h.

insertItem()

bool ml::DcmDRTVOILUTSequenceInterface::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 156 of file mlDcmDRTVOILUTSequenceInterface.h.

removeItem()

bool ml::DcmDRTVOILUTSequenceInterface::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 168 of file mlDcmDRTVOILUTSequenceInterface.h.

setLUTDescriptor()

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

setLUTExplanation()

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

setSequence()

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

inline

Set the DRTVOILUTSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTVOILUTSequence

Definition at line 112 of file mlDcmDRTVOILUTSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTVOILUTSequenceInterface.h.

---

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

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