ml::DcmDRTOverrideSequenceInterface Class Reference

Class to provide access to DRTOverrideSequence. More...

#include <mlDcmDRTOverrideSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTOverrideSequenceInterface ()
	DcmDRTOverrideSequenceInterface (std::vector< DcmDRTOverrideSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTOverrideSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTOverrideSequenceInterface ()
	Default virtual Destructor.
bool	getOperatorsName (unsigned long idx, std::string &parameter) const
bool	getOperatorsName (DCMTree::TreePtr item, std::string &parameter) const
std::string	getOperatorsNameTag () const
bool	setOperatorsName (unsigned long idx, std::string parameter)
bool	getOverrideReason (unsigned long idx, std::string &parameter) const
bool	getOverrideReason (DCMTree::TreePtr item, std::string &parameter) const
std::string	getOverrideReasonTag () const
bool	setOverrideReason (unsigned long idx, std::string parameter)
bool	getParameterItemIndex (unsigned long idx, std::string &parameter) const
bool	getParameterItemIndex (DCMTree::TreePtr item, std::string &parameter) const
std::string	getParameterItemIndexTag () const
bool	setParameterItemIndex (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTOverrideSequenceInterface::Item > dcmSequence)
	Set the DRTOverrideSequence this interface class provides access to.
std::vector< DcmDRTOverrideSequenceInterface::Item >	getSequence () const
	Return the DRTOverrideSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTOverrideSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTOverrideSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTOverrideSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTOverrideSequenceInterface::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< DcmDRTOverrideSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTOverrideSequence.

Definition at line 43 of file mlDcmDRTOverrideSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTOverrideSequenceInterface() [1/3]

ml::DcmDRTOverrideSequenceInterface::DcmDRTOverrideSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTOverrideSequenceInterface.h.

DcmDRTOverrideSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTOverrideSequenceInterface.h.

DcmDRTOverrideSequenceInterface() [3/3]

ml::DcmDRTOverrideSequenceInterface::DcmDRTOverrideSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTOverrideSequenceInterface.h.

References mlrange_cast().

~DcmDRTOverrideSequenceInterface()

virtual ml::DcmDRTOverrideSequenceInterface::~DcmDRTOverrideSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTOverrideSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTOverrideSequenceInterface::Item & ml::DcmDRTOverrideSequenceInterface::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 mlDcmDRTOverrideSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTOverrideSequenceInterface.h.

References mlrange_cast().

getItem()

DcmDRTOverrideSequenceInterface::Item ml::DcmDRTOverrideSequenceInterface::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 mlDcmDRTOverrideSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTOverrideSequenceInterface::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 mlDcmDRTOverrideSequenceInterface.h.

getOperatorsName() [1/2]

bool ml::DcmDRTOverrideSequenceInterface::getOperatorsName	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getOperatorsName() [2/2]

bool ml::DcmDRTOverrideSequenceInterface::getOperatorsName	(	unsigned long	idx,
		std::string &	parameter ) const

getOperatorsNameTag()

std::string ml::DcmDRTOverrideSequenceInterface::getOperatorsNameTag ( ) const

inline

Definition at line 105 of file mlDcmDRTOverrideSequenceInterface.h.

Referenced by DRTOverrideSequenceWrapper::getOperatorsNameTag().

getOverrideReason() [1/2]

bool ml::DcmDRTOverrideSequenceInterface::getOverrideReason	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getOverrideReason() [2/2]

bool ml::DcmDRTOverrideSequenceInterface::getOverrideReason	(	unsigned long	idx,
		std::string &	parameter ) const

getOverrideReasonTag()

std::string ml::DcmDRTOverrideSequenceInterface::getOverrideReasonTag ( ) const

inline

Definition at line 111 of file mlDcmDRTOverrideSequenceInterface.h.

Referenced by DRTOverrideSequenceWrapper::getOverrideReasonTag().

getParameterItemIndex() [1/2]

bool ml::DcmDRTOverrideSequenceInterface::getParameterItemIndex	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getParameterItemIndex() [2/2]

bool ml::DcmDRTOverrideSequenceInterface::getParameterItemIndex	(	unsigned long	idx,
		std::string &	parameter ) const

getParameterItemIndexTag()

std::string ml::DcmDRTOverrideSequenceInterface::getParameterItemIndexTag ( ) const

inline

Definition at line 117 of file mlDcmDRTOverrideSequenceInterface.h.

Referenced by DRTOverrideSequenceWrapper::getParameterItemIndexTag().

getSequence()

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

inline

Return the DRTOverrideSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTOverrideSequence

Definition at line 129 of file mlDcmDRTOverrideSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTOverrideSequenceInterface::hasSequence ( ) const

inline

Check if the DRTOverrideSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTOverrideSequenceInterface.h.

insertItem()

bool ml::DcmDRTOverrideSequenceInterface::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 mlDcmDRTOverrideSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTOverrideSequenceInterface::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 mlDcmDRTOverrideSequenceInterface.h.

References mlrange_cast().

setOperatorsName()

bool ml::DcmDRTOverrideSequenceInterface::setOperatorsName	(	unsigned long	idx,
		std::string	parameter )

setOverrideReason()

bool ml::DcmDRTOverrideSequenceInterface::setOverrideReason	(	unsigned long	idx,
		std::string	parameter )

setParameterItemIndex()

bool ml::DcmDRTOverrideSequenceInterface::setParameterItemIndex	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTOverrideSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTOverrideSequence

Definition at line 123 of file mlDcmDRTOverrideSequenceInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTOverrideSequenceInterface.h.

---

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

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