ml::DcmDRTLateralSpreadingDeviceSequenceInterface Class Reference

Class to provide access to DRTLateralSpreadingDeviceSequence. More...

#include <mlDcmDRTLateralSpreadingDeviceSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTLateralSpreadingDeviceSequenceInterface ()
	DcmDRTLateralSpreadingDeviceSequenceInterface (std::vector< DcmDRTLateralSpreadingDeviceSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTLateralSpreadingDeviceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTLateralSpreadingDeviceSequenceInterface ()
	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	getLateralSpreadingDeviceDescription (unsigned long idx, std::string &parameter) const
bool	getLateralSpreadingDeviceDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLateralSpreadingDeviceDescriptionTag () const
bool	setLateralSpreadingDeviceDescription (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	getLateralSpreadingDeviceNumber (unsigned long idx, std::string &parameter) const
bool	getLateralSpreadingDeviceNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLateralSpreadingDeviceNumberTag () const
bool	setLateralSpreadingDeviceNumber (unsigned long idx, std::string parameter)
bool	getLateralSpreadingDeviceType (unsigned long idx, std::string &parameter) const
bool	getLateralSpreadingDeviceType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getLateralSpreadingDeviceTypeTag () const
bool	setLateralSpreadingDeviceType (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTLateralSpreadingDeviceSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTLateralSpreadingDeviceSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTLateralSpreadingDeviceSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTLateralSpreadingDeviceSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTLateralSpreadingDeviceSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTLateralSpreadingDeviceSequence.

Definition at line 43 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTLateralSpreadingDeviceSequenceInterface() [1/3]

ml::DcmDRTLateralSpreadingDeviceSequenceInterface::DcmDRTLateralSpreadingDeviceSequenceInterface ( )

inline

Definition at line 98 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

DcmDRTLateralSpreadingDeviceSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 101 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

DcmDRTLateralSpreadingDeviceSequenceInterface() [3/3]

ml::DcmDRTLateralSpreadingDeviceSequenceInterface::DcmDRTLateralSpreadingDeviceSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 103 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

~DcmDRTLateralSpreadingDeviceSequenceInterface()

virtual ml::DcmDRTLateralSpreadingDeviceSequenceInterface::~DcmDRTLateralSpreadingDeviceSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTLateralSpreadingDeviceSequenceInterface::Item & ml::DcmDRTLateralSpreadingDeviceSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 178 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

getAccessoryCode() [1/2]

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

getAccessoryCode() [2/2]

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

getAccessoryCodeTag()

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

inline

Definition at line 115 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

getItem()

DcmDRTLateralSpreadingDeviceSequenceInterface::Item ml::DcmDRTLateralSpreadingDeviceSequenceInterface::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 169 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

getLateralSpreadingDeviceDescription() [1/2]

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getLateralSpreadingDeviceDescription() [2/2]

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getLateralSpreadingDeviceDescriptionTag()

std::string ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceDescriptionTag ( ) const

inline

Definition at line 121 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

getLateralSpreadingDeviceID() [1/2]

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

getLateralSpreadingDeviceID() [2/2]

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

getLateralSpreadingDeviceIDTag()

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

inline

Definition at line 127 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

getLateralSpreadingDeviceNumber() [1/2]

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getLateralSpreadingDeviceNumber() [2/2]

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getLateralSpreadingDeviceNumberTag()

std::string ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceNumberTag ( ) const

inline

Definition at line 133 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

getLateralSpreadingDeviceType() [1/2]

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getLateralSpreadingDeviceType() [2/2]

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceType	(	unsigned long	idx,
		std::string &	parameter ) const

getLateralSpreadingDeviceTypeTag()

std::string ml::DcmDRTLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceTypeTag ( ) const

inline

Definition at line 139 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTLateralSpreadingDeviceSequenceInterface::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 163 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

getSequence()

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

inline

Return the DRTLateralSpreadingDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTLateralSpreadingDeviceSequence

Definition at line 151 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::hasSequence ( ) const

inline

Check if the DRTLateralSpreadingDeviceSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::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 189 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::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 201 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

setAccessoryCode()

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

setLateralSpreadingDeviceDescription()

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::setLateralSpreadingDeviceDescription	(	unsigned long	idx,
		std::string	parameter )

setLateralSpreadingDeviceID()

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

setLateralSpreadingDeviceNumber()

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::setLateralSpreadingDeviceNumber	(	unsigned long	idx,
		std::string	parameter )

setLateralSpreadingDeviceType()

bool ml::DcmDRTLateralSpreadingDeviceSequenceInterface::setLateralSpreadingDeviceType	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTLateralSpreadingDeviceSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTLateralSpreadingDeviceSequence

Definition at line 145 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTLateralSpreadingDeviceSequenceInterface.h.

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