ml::DcmDRTSnoutSequenceInterface Class Reference

Class to provide access to DRTSnoutSequence. More...

#include <mlDcmDRTSnoutSequenceInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTSnoutSequence.

Definition at line 43 of file mlDcmDRTSnoutSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTSnoutSequenceInterface() [1/3]

ml::DcmDRTSnoutSequenceInterface::DcmDRTSnoutSequenceInterface ( )

inline

Definition at line 83 of file mlDcmDRTSnoutSequenceInterface.h.

DcmDRTSnoutSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 86 of file mlDcmDRTSnoutSequenceInterface.h.

DcmDRTSnoutSequenceInterface() [3/3]

ml::DcmDRTSnoutSequenceInterface::DcmDRTSnoutSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 88 of file mlDcmDRTSnoutSequenceInterface.h.

References mlrange_cast().

~DcmDRTSnoutSequenceInterface()

virtual ml::DcmDRTSnoutSequenceInterface::~DcmDRTSnoutSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTSnoutSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTSnoutSequenceInterface::Item & ml::DcmDRTSnoutSequenceInterface::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 mlDcmDRTSnoutSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTSnoutSequenceInterface.h.

References mlrange_cast().

getAccessoryCode() [1/2]

bool ml::DcmDRTSnoutSequenceInterface::getAccessoryCode	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getAccessoryCode() [2/2]

bool ml::DcmDRTSnoutSequenceInterface::getAccessoryCode	(	unsigned long	idx,
		std::string &	parameter ) const

getAccessoryCodeTag()

std::string ml::DcmDRTSnoutSequenceInterface::getAccessoryCodeTag ( ) const

inline

Definition at line 100 of file mlDcmDRTSnoutSequenceInterface.h.

Referenced by DRTSnoutSequenceWrapper::getAccessoryCodeTag().

getItem()

DcmDRTSnoutSequenceInterface::Item ml::DcmDRTSnoutSequenceInterface::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 mlDcmDRTSnoutSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTSnoutSequenceInterface::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 mlDcmDRTSnoutSequenceInterface.h.

getSequence()

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

inline

Return the DRTSnoutSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSnoutSequence

Definition at line 118 of file mlDcmDRTSnoutSequenceInterface.h.

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

getSnoutID() [1/2]

bool ml::DcmDRTSnoutSequenceInterface::getSnoutID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSnoutID() [2/2]

bool ml::DcmDRTSnoutSequenceInterface::getSnoutID	(	unsigned long	idx,
		std::string &	parameter ) const

getSnoutIDTag()

std::string ml::DcmDRTSnoutSequenceInterface::getSnoutIDTag ( ) const

inline

Definition at line 106 of file mlDcmDRTSnoutSequenceInterface.h.

Referenced by DRTSnoutSequenceWrapper::getSnoutIDTag().

hasSequence()

bool ml::DcmDRTSnoutSequenceInterface::hasSequence ( ) const

inline

Check if the DRTSnoutSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTSnoutSequenceInterface.h.

insertItem()

bool ml::DcmDRTSnoutSequenceInterface::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 mlDcmDRTSnoutSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTSnoutSequenceInterface::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 mlDcmDRTSnoutSequenceInterface.h.

References mlrange_cast().

setAccessoryCode()

bool ml::DcmDRTSnoutSequenceInterface::setAccessoryCode	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTSnoutSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTSnoutSequence

Definition at line 112 of file mlDcmDRTSnoutSequenceInterface.h.

References mlrange_cast().

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

setSnoutID()

bool ml::DcmDRTSnoutSequenceInterface::setSnoutID	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTSnoutSequenceInterface.h.

---

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

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