ml::DcmDRTRecordedRangeModulatorSequenceInterface Class Reference

Class to provide access to DRTRecordedRangeModulatorSequence. More...

#include <mlDcmDRTRecordedRangeModulatorSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRecordedRangeModulatorSequenceInterface ()
	DcmDRTRecordedRangeModulatorSequenceInterface (std::vector< DcmDRTRecordedRangeModulatorSequenceInterface::Item > dcmSequence)
	Default Constructor. More...
	DcmDRTRecordedRangeModulatorSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRecordedRangeModulatorSequenceInterface ()
	Default virtual Destructor. More...
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	getBeamCurrentModulationID (unsigned long idx, std::string &parameter) const
bool	getBeamCurrentModulationID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getBeamCurrentModulationIDTag () const
bool	setBeamCurrentModulationID (unsigned long idx, std::string parameter)
bool	getRangeModulatorID (unsigned long idx, std::string &parameter) const
bool	getRangeModulatorID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRangeModulatorIDTag () const
bool	setRangeModulatorID (unsigned long idx, std::string parameter)
bool	getRangeModulatorType (unsigned long idx, std::string &parameter) const
bool	getRangeModulatorType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRangeModulatorTypeTag () const
bool	setRangeModulatorType (unsigned long idx, std::string parameter)
bool	getReferencedRangeModulatorNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedRangeModulatorNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedRangeModulatorNumberTag () const
bool	setReferencedRangeModulatorNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTRecordedRangeModulatorSequenceInterface::Item > dcmSequence)
	Set the DRTRecordedRangeModulatorSequence this interface class provides access to. More...
std::vector< DcmDRTRecordedRangeModulatorSequenceInterface::Item >	getSequence () const
	Return the DRTRecordedRangeModulatorSequence this interface class provides access to. More...
bool	hasSequence () const
	Check if the DRTRecordedRangeModulatorSequence is set. More...
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of. More...
DcmDRTRecordedRangeModulatorSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position. More...
DcmDRTRecordedRangeModulatorSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence. More...
void	addItem (DcmDRTRecordedRangeModulatorSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position. More...
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence. More...

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

Detailed Description

Class to provide access to DRTRecordedRangeModulatorSequence.

Definition at line 43 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTRecordedRangeModulatorSequenceInterface() [1/3]

ml::DcmDRTRecordedRangeModulatorSequenceInterface::DcmDRTRecordedRangeModulatorSequenceInterface ( )

inline

Definition at line 98 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

DcmDRTRecordedRangeModulatorSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 101 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

DcmDRTRecordedRangeModulatorSequenceInterface() [3/3]

ml::DcmDRTRecordedRangeModulatorSequenceInterface::DcmDRTRecordedRangeModulatorSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 103 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

~DcmDRTRecordedRangeModulatorSequenceInterface()

virtual ml::DcmDRTRecordedRangeModulatorSequenceInterface::~DcmDRTRecordedRangeModulatorSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRecordedRangeModulatorSequenceInterface::Item& ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

getAccessoryCode() [1/2]

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

getAccessoryCode() [2/2]

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

getAccessoryCodeTag()

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

inline

Definition at line 115 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Referenced by DRTRecordedRangeModulatorSequenceWrapper::getAccessoryCodeTag().

getBeamCurrentModulationID() [1/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getBeamCurrentModulationID	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getBeamCurrentModulationID() [2/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getBeamCurrentModulationID	(	unsigned long	idx,
		std::string &	parameter
	)		const

getBeamCurrentModulationIDTag()

std::string ml::DcmDRTRecordedRangeModulatorSequenceInterface::getBeamCurrentModulationIDTag ( ) const

inline

Definition at line 121 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Referenced by DRTRecordedRangeModulatorSequenceWrapper::getBeamCurrentModulationIDTag().

getItem()

DcmDRTRecordedRangeModulatorSequenceInterface::Item ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

getNumberOfItems()

MLint ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

getRangeModulatorID() [1/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorID	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getRangeModulatorID() [2/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorID	(	unsigned long	idx,
		std::string &	parameter
	)		const

getRangeModulatorIDTag()

std::string ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorIDTag ( ) const

inline

Definition at line 127 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Referenced by DRTRecordedRangeModulatorSequenceWrapper::getRangeModulatorIDTag().

getRangeModulatorType() [1/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorType	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getRangeModulatorType() [2/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorType	(	unsigned long	idx,
		std::string &	parameter
	)		const

getRangeModulatorTypeTag()

std::string ml::DcmDRTRecordedRangeModulatorSequenceInterface::getRangeModulatorTypeTag ( ) const

inline

Definition at line 133 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Referenced by DRTRecordedRangeModulatorSequenceWrapper::getRangeModulatorTypeTag().

getReferencedRangeModulatorNumber() [1/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getReferencedRangeModulatorNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getReferencedRangeModulatorNumber() [2/2]

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::getReferencedRangeModulatorNumber	(	unsigned long	idx,
		std::string &	parameter
	)		const

getReferencedRangeModulatorNumberTag()

std::string ml::DcmDRTRecordedRangeModulatorSequenceInterface::getReferencedRangeModulatorNumberTag ( ) const

inline

Definition at line 139 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

Referenced by DRTRecordedRangeModulatorSequenceWrapper::getReferencedRangeModulatorNumberTag().

getSequence()

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

inline

Return the DRTRecordedRangeModulatorSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRecordedRangeModulatorSequence

Definition at line 151 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::hasSequence ( ) const

inline

Check if the DRTRecordedRangeModulatorSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

insertItem()

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

removeItem()

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::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 mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

setAccessoryCode()

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

setBeamCurrentModulationID()

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::setBeamCurrentModulationID	(	unsigned long	idx,
		std::string	parameter
	)

setRangeModulatorID()

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::setRangeModulatorID	(	unsigned long	idx,
		std::string	parameter
	)

setRangeModulatorType()

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::setRangeModulatorType	(	unsigned long	idx,
		std::string	parameter
	)

setReferencedRangeModulatorNumber()

bool ml::DcmDRTRecordedRangeModulatorSequenceInterface::setReferencedRangeModulatorNumber	(	unsigned long	idx,
		std::string	parameter
	)

setSequence()

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

inline

Set the DRTRecordedRangeModulatorSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRecordedRangeModulatorSequence

Definition at line 145 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTRecordedRangeModulatorSequenceInterface.h.

---

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

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