ml::DcmDRTRecordedRangeShifterSequenceInterface Class Reference

Class to provide access to DRTRecordedRangeShifterSequence. More...

#include <mlDcmDRTRecordedRangeShifterSequenceInterface.h>

Classes
class	Item

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

Detailed Description

Class to provide access to DRTRecordedRangeShifterSequence.

Definition at line 43 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTRecordedRangeShifterSequenceInterface() [1/3]

ml::DcmDRTRecordedRangeShifterSequenceInterface::DcmDRTRecordedRangeShifterSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

DcmDRTRecordedRangeShifterSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

DcmDRTRecordedRangeShifterSequenceInterface() [3/3]

ml::DcmDRTRecordedRangeShifterSequenceInterface::DcmDRTRecordedRangeShifterSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

~DcmDRTRecordedRangeShifterSequenceInterface()

virtual ml::DcmDRTRecordedRangeShifterSequenceInterface::~DcmDRTRecordedRangeShifterSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRecordedRangeShifterSequenceInterface::Item & ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

getAccessoryCode() [1/2]

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

getAccessoryCode() [2/2]

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

getAccessoryCodeTag()

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

inline

Definition at line 105 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

Referenced by DRTRecordedRangeShifterSequenceWrapper::getAccessoryCodeTag().

getItem()

DcmDRTRecordedRangeShifterSequenceInterface::Item ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

getRangeShifterID() [1/2]

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getRangeShifterID	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getRangeShifterID() [2/2]

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getRangeShifterID	(	unsigned long	idx,
		std::string &	parameter
	)		const

getRangeShifterIDTag()

std::string ml::DcmDRTRecordedRangeShifterSequenceInterface::getRangeShifterIDTag ( ) const

inline

Definition at line 111 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

Referenced by DRTRecordedRangeShifterSequenceWrapper::getRangeShifterIDTag().

getReferencedRangeShifterNumber() [1/2]

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getReferencedRangeShifterNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getReferencedRangeShifterNumber() [2/2]

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::getReferencedRangeShifterNumber	(	unsigned long	idx,
		std::string &	parameter
	)		const

getReferencedRangeShifterNumberTag()

std::string ml::DcmDRTRecordedRangeShifterSequenceInterface::getReferencedRangeShifterNumberTag ( ) const

inline

Definition at line 117 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

Referenced by DRTRecordedRangeShifterSequenceWrapper::getReferencedRangeShifterNumberTag().

getSequence()

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

inline

Return the DRTRecordedRangeShifterSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRecordedRangeShifterSequence

Definition at line 129 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::hasSequence ( ) const

inline

Check if the DRTRecordedRangeShifterSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

insertItem()

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

removeItem()

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::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 mlDcmDRTRecordedRangeShifterSequenceInterface.h.

setAccessoryCode()

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

setRangeShifterID()

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::setRangeShifterID	(	unsigned long	idx,
		std::string	parameter
	)

setReferencedRangeShifterNumber()

bool ml::DcmDRTRecordedRangeShifterSequenceInterface::setReferencedRangeShifterNumber	(	unsigned long	idx,
		std::string	parameter
	)

setSequence()

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

inline

Set the DRTRecordedRangeShifterSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRecordedRangeShifterSequence

Definition at line 123 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTRecordedRangeShifterSequenceInterface.h.

---

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

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