ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface Class Reference

Class to provide access to DRTRecordedLateralSpreadingDeviceSequence. More...

#include <mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ()
	DcmDRTRecordedLateralSpreadingDeviceSequenceInterface (std::vector< DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRecordedLateralSpreadingDeviceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ()
	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	getLateralSpreadingDeviceID (unsigned long idx, std::string &parameter) const
bool	getLateralSpreadingDeviceID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLateralSpreadingDeviceIDTag () const
bool	setLateralSpreadingDeviceID (unsigned long idx, std::string parameter)
bool	getReferencedLateralSpreadingDeviceNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedLateralSpreadingDeviceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedLateralSpreadingDeviceNumberTag () const
bool	setReferencedLateralSpreadingDeviceNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTRecordedLateralSpreadingDeviceSequence.

Definition at line 43 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTRecordedLateralSpreadingDeviceSequenceInterface() [1/3]

ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

DcmDRTRecordedLateralSpreadingDeviceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

DcmDRTRecordedLateralSpreadingDeviceSequenceInterface() [3/3]

ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

~DcmDRTRecordedLateralSpreadingDeviceSequenceInterface()

virtual ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::~DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item & ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

getAccessoryCode() [1/2]

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

getAccessoryCode() [2/2]

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

getAccessoryCodeTag()

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

inline

Definition at line 105 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

getItem()

DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

getLateralSpreadingDeviceID() [1/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getLateralSpreadingDeviceID() [2/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceID	(	unsigned long	idx,
		std::string &	parameter ) const

getLateralSpreadingDeviceIDTag()

std::string ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceIDTag ( ) const

inline

Definition at line 111 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

getReferencedLateralSpreadingDeviceNumber() [1/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getReferencedLateralSpreadingDeviceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedLateralSpreadingDeviceNumber() [2/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getReferencedLateralSpreadingDeviceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedLateralSpreadingDeviceNumberTag()

std::string ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getReferencedLateralSpreadingDeviceNumberTag ( ) const

inline

Definition at line 117 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

getSequence()

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

inline

Return the DRTRecordedLateralSpreadingDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRecordedLateralSpreadingDeviceSequence

Definition at line 129 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTRecordedLateralSpreadingDeviceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

setAccessoryCode()

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

setLateralSpreadingDeviceID()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::setLateralSpreadingDeviceID	(	unsigned long	idx,
		std::string	parameter )

setReferencedLateralSpreadingDeviceNumber()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::setReferencedLateralSpreadingDeviceNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTRecordedLateralSpreadingDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRecordedLateralSpreadingDeviceSequence

Definition at line 123 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

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