ml::DcmDRTPatientSetupSequenceInterface Class Reference

Class to provide access to DRTPatientSetupSequence. More...

#include <mlDcmDRTPatientSetupSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTPatientSetupSequenceInterface ()
	DcmDRTPatientSetupSequenceInterface (std::vector< DcmDRTPatientSetupSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTPatientSetupSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTPatientSetupSequenceInterface ()
	Default virtual Destructor.
bool	getPatientAdditionalPosition (unsigned long idx, std::string &parameter) const
bool	getPatientAdditionalPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getPatientAdditionalPositionTag () const
bool	setPatientAdditionalPosition (unsigned long idx, std::string parameter)
bool	getPatientPosition (unsigned long idx, std::string &parameter) const
bool	getPatientPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getPatientPositionTag () const
bool	setPatientPosition (unsigned long idx, std::string parameter)
bool	getPatientSetupLabel (unsigned long idx, std::string &parameter) const
bool	getPatientSetupLabel (DCMTree::TreePtr item, std::string &parameter) const
std::string	getPatientSetupLabelTag () const
bool	setPatientSetupLabel (unsigned long idx, std::string parameter)
bool	getPatientSetupNumber (unsigned long idx, std::string &parameter) const
bool	getPatientSetupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getPatientSetupNumberTag () const
bool	setPatientSetupNumber (unsigned long idx, std::string parameter)
bool	getSetupTechnique (unsigned long idx, std::string &parameter) const
bool	getSetupTechnique (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSetupTechniqueTag () const
bool	setSetupTechnique (unsigned long idx, std::string parameter)
bool	getSetupTechniqueDescription (unsigned long idx, std::string &parameter) const
bool	getSetupTechniqueDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSetupTechniqueDescriptionTag () const
bool	setSetupTechniqueDescription (unsigned long idx, std::string parameter)
bool	getTableTopLateralSetupDisplacement (unsigned long idx, std::string &parameter) const
bool	getTableTopLateralSetupDisplacement (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTableTopLateralSetupDisplacementTag () const
bool	setTableTopLateralSetupDisplacement (unsigned long idx, std::string parameter)
bool	getTableTopLongitudinalSetupDisplacement (unsigned long idx, std::string &parameter) const
bool	getTableTopLongitudinalSetupDisplacement (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTableTopLongitudinalSetupDisplacementTag () const
bool	setTableTopLongitudinalSetupDisplacement (unsigned long idx, std::string parameter)
bool	getTableTopVerticalSetupDisplacement (unsigned long idx, std::string &parameter) const
bool	getTableTopVerticalSetupDisplacement (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTableTopVerticalSetupDisplacementTag () const
bool	setTableTopVerticalSetupDisplacement (unsigned long idx, std::string parameter)
DcmDRTFixationDeviceSequenceInterface	getFixationDeviceSequence (unsigned long idx) const
std::string	getFixationDeviceSequenceTag () const
void	setFixationDeviceSequence (DcmDRTFixationDeviceSequenceInterface seq, unsigned long idx)
DcmDRTMotionSynchronizationSequenceInterface	getMotionSynchronizationSequence (unsigned long idx) const
std::string	getMotionSynchronizationSequenceTag () const
void	setMotionSynchronizationSequence (DcmDRTMotionSynchronizationSequenceInterface seq, unsigned long idx)
DcmDRTReferencedSetupImageSequenceInterface	getReferencedSetupImageSequence (unsigned long idx) const
std::string	getReferencedSetupImageSequenceTag () const
void	setReferencedSetupImageSequence (DcmDRTReferencedSetupImageSequenceInterface seq, unsigned long idx)
DcmDRTSetupDeviceSequenceInterface	getSetupDeviceSequence (unsigned long idx) const
std::string	getSetupDeviceSequenceTag () const
void	setSetupDeviceSequence (DcmDRTSetupDeviceSequenceInterface seq, unsigned long idx)
DcmDRTShieldingDeviceSequenceInterface	getShieldingDeviceSequence (unsigned long idx) const
std::string	getShieldingDeviceSequenceTag () const
void	setShieldingDeviceSequence (DcmDRTShieldingDeviceSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTPatientSetupSequenceInterface::Item > dcmSequence)
	Set the DRTPatientSetupSequence this interface class provides access to.
std::vector< DcmDRTPatientSetupSequenceInterface::Item >	getSequence () const
	Return the DRTPatientSetupSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTPatientSetupSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTPatientSetupSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTPatientSetupSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTPatientSetupSequenceInterface::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< DcmDRTPatientSetupSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTPatientSetupSequence.

Definition at line 48 of file mlDcmDRTPatientSetupSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTPatientSetupSequenceInterface() [1/3]

ml::DcmDRTPatientSetupSequenceInterface::DcmDRTPatientSetupSequenceInterface ( )

inline

Definition at line 148 of file mlDcmDRTPatientSetupSequenceInterface.h.

DcmDRTPatientSetupSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 151 of file mlDcmDRTPatientSetupSequenceInterface.h.

DcmDRTPatientSetupSequenceInterface() [3/3]

ml::DcmDRTPatientSetupSequenceInterface::DcmDRTPatientSetupSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 153 of file mlDcmDRTPatientSetupSequenceInterface.h.

~DcmDRTPatientSetupSequenceInterface()

virtual ml::DcmDRTPatientSetupSequenceInterface::~DcmDRTPatientSetupSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 161 of file mlDcmDRTPatientSetupSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTPatientSetupSequenceInterface::Item & ml::DcmDRTPatientSetupSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 277 of file mlDcmDRTPatientSetupSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 282 of file mlDcmDRTPatientSetupSequenceInterface.h.

getFixationDeviceSequence()

DcmDRTFixationDeviceSequenceInterface ml::DcmDRTPatientSetupSequenceInterface::getFixationDeviceSequence

(

unsigned long

idx

)

const

getFixationDeviceSequenceTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getFixationDeviceSequenceTag ( ) const

inline

Definition at line 218 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getFixationDeviceSequenceTag().

getItem()

DcmDRTPatientSetupSequenceInterface::Item ml::DcmDRTPatientSetupSequenceInterface::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 268 of file mlDcmDRTPatientSetupSequenceInterface.h.

getMotionSynchronizationSequence()

DcmDRTMotionSynchronizationSequenceInterface ml::DcmDRTPatientSetupSequenceInterface::getMotionSynchronizationSequence

(

unsigned long

idx

)

const

getMotionSynchronizationSequenceTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getMotionSynchronizationSequenceTag ( ) const

inline

Definition at line 223 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getMotionSynchronizationSequenceTag().

getNumberOfItems()

MLint ml::DcmDRTPatientSetupSequenceInterface::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 262 of file mlDcmDRTPatientSetupSequenceInterface.h.

getPatientAdditionalPosition() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientAdditionalPosition	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getPatientAdditionalPosition() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientAdditionalPosition	(	unsigned long	idx,
		std::string &	parameter
	)		const

getPatientAdditionalPositionTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientAdditionalPositionTag ( ) const

inline

Definition at line 165 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getPatientAdditionalPositionTag().

getPatientPosition() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientPosition	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getPatientPosition() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientPosition	(	unsigned long	idx,
		std::string &	parameter
	)		const

getPatientPositionTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientPositionTag ( ) const

inline

Definition at line 171 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getPatientPositionTag().

getPatientSetupLabel() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupLabel	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getPatientSetupLabel() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupLabel	(	unsigned long	idx,
		std::string &	parameter
	)		const

getPatientSetupLabelTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupLabelTag ( ) const

inline

Definition at line 177 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getPatientSetupLabelTag().

getPatientSetupNumber() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getPatientSetupNumber() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupNumber	(	unsigned long	idx,
		std::string &	parameter
	)		const

getPatientSetupNumberTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupNumberTag ( ) const

inline

Definition at line 183 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getPatientSetupNumberTag().

getReferencedSetupImageSequence()

DcmDRTReferencedSetupImageSequenceInterface ml::DcmDRTPatientSetupSequenceInterface::getReferencedSetupImageSequence

(

unsigned long

idx

)

const

getReferencedSetupImageSequenceTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getReferencedSetupImageSequenceTag ( ) const

inline

Definition at line 228 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getReferencedSetupImageSequenceTag().

getSequence()

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

inline

Return the DRTPatientSetupSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTPatientSetupSequence

Definition at line 250 of file mlDcmDRTPatientSetupSequenceInterface.h.

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

getSetupDeviceSequence()

DcmDRTSetupDeviceSequenceInterface ml::DcmDRTPatientSetupSequenceInterface::getSetupDeviceSequence

(

unsigned long

idx

)

const

getSetupDeviceSequenceTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getSetupDeviceSequenceTag ( ) const

inline

Definition at line 233 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getSetupDeviceSequenceTag().

getSetupTechnique() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getSetupTechnique	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getSetupTechnique() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getSetupTechnique	(	unsigned long	idx,
		std::string &	parameter
	)		const

getSetupTechniqueDescription() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getSetupTechniqueDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getSetupTechniqueDescription() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getSetupTechniqueDescription	(	unsigned long	idx,
		std::string &	parameter
	)		const

getSetupTechniqueDescriptionTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getSetupTechniqueDescriptionTag ( ) const

inline

Definition at line 195 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getSetupTechniqueDescriptionTag().

getSetupTechniqueTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getSetupTechniqueTag ( ) const

inline

Definition at line 189 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getSetupTechniqueTag().

getShieldingDeviceSequence()

DcmDRTShieldingDeviceSequenceInterface ml::DcmDRTPatientSetupSequenceInterface::getShieldingDeviceSequence

(

unsigned long

idx

)

const

getShieldingDeviceSequenceTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getShieldingDeviceSequenceTag ( ) const

inline

Definition at line 238 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getShieldingDeviceSequenceTag().

getTableTopLateralSetupDisplacement() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopLateralSetupDisplacement	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getTableTopLateralSetupDisplacement() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopLateralSetupDisplacement	(	unsigned long	idx,
		std::string &	parameter
	)		const

getTableTopLateralSetupDisplacementTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getTableTopLateralSetupDisplacementTag ( ) const

inline

Definition at line 201 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getTableTopLateralSetupDisplacementTag().

getTableTopLongitudinalSetupDisplacement() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopLongitudinalSetupDisplacement	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getTableTopLongitudinalSetupDisplacement() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopLongitudinalSetupDisplacement	(	unsigned long	idx,
		std::string &	parameter
	)		const

getTableTopLongitudinalSetupDisplacementTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getTableTopLongitudinalSetupDisplacementTag ( ) const

inline

Definition at line 207 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getTableTopLongitudinalSetupDisplacementTag().

getTableTopVerticalSetupDisplacement() [1/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopVerticalSetupDisplacement	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getTableTopVerticalSetupDisplacement() [2/2]

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopVerticalSetupDisplacement	(	unsigned long	idx,
		std::string &	parameter
	)		const

getTableTopVerticalSetupDisplacementTag()

std::string ml::DcmDRTPatientSetupSequenceInterface::getTableTopVerticalSetupDisplacementTag ( ) const

inline

Definition at line 213 of file mlDcmDRTPatientSetupSequenceInterface.h.

Referenced by DRTPatientSetupSequenceWrapper::getTableTopVerticalSetupDisplacementTag().

hasSequence()

bool ml::DcmDRTPatientSetupSequenceInterface::hasSequence ( ) const

inline

Check if the DRTPatientSetupSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 256 of file mlDcmDRTPatientSetupSequenceInterface.h.

insertItem()

bool ml::DcmDRTPatientSetupSequenceInterface::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 288 of file mlDcmDRTPatientSetupSequenceInterface.h.

removeItem()

bool ml::DcmDRTPatientSetupSequenceInterface::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 300 of file mlDcmDRTPatientSetupSequenceInterface.h.

setFixationDeviceSequence()

void ml::DcmDRTPatientSetupSequenceInterface::setFixationDeviceSequence	(	DcmDRTFixationDeviceSequenceInterface	seq,
		unsigned long	idx
	)

setMotionSynchronizationSequence()

void ml::DcmDRTPatientSetupSequenceInterface::setMotionSynchronizationSequence	(	DcmDRTMotionSynchronizationSequenceInterface	seq,
		unsigned long	idx
	)

setPatientAdditionalPosition()

bool ml::DcmDRTPatientSetupSequenceInterface::setPatientAdditionalPosition	(	unsigned long	idx,
		std::string	parameter
	)

setPatientPosition()

bool ml::DcmDRTPatientSetupSequenceInterface::setPatientPosition	(	unsigned long	idx,
		std::string	parameter
	)

setPatientSetupLabel()

bool ml::DcmDRTPatientSetupSequenceInterface::setPatientSetupLabel	(	unsigned long	idx,
		std::string	parameter
	)

setPatientSetupNumber()

bool ml::DcmDRTPatientSetupSequenceInterface::setPatientSetupNumber	(	unsigned long	idx,
		std::string	parameter
	)

setReferencedSetupImageSequence()

void ml::DcmDRTPatientSetupSequenceInterface::setReferencedSetupImageSequence	(	DcmDRTReferencedSetupImageSequenceInterface	seq,
		unsigned long	idx
	)

setSequence()

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

inline

Set the DRTPatientSetupSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTPatientSetupSequence

Definition at line 244 of file mlDcmDRTPatientSetupSequenceInterface.h.

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

setSetupDeviceSequence()

void ml::DcmDRTPatientSetupSequenceInterface::setSetupDeviceSequence	(	DcmDRTSetupDeviceSequenceInterface	seq,
		unsigned long	idx
	)

setSetupTechnique()

bool ml::DcmDRTPatientSetupSequenceInterface::setSetupTechnique	(	unsigned long	idx,
		std::string	parameter
	)

setSetupTechniqueDescription()

bool ml::DcmDRTPatientSetupSequenceInterface::setSetupTechniqueDescription	(	unsigned long	idx,
		std::string	parameter
	)

setShieldingDeviceSequence()

void ml::DcmDRTPatientSetupSequenceInterface::setShieldingDeviceSequence	(	DcmDRTShieldingDeviceSequenceInterface	seq,
		unsigned long	idx
	)

setTableTopLateralSetupDisplacement()

bool ml::DcmDRTPatientSetupSequenceInterface::setTableTopLateralSetupDisplacement	(	unsigned long	idx,
		std::string	parameter
	)

setTableTopLongitudinalSetupDisplacement()

bool ml::DcmDRTPatientSetupSequenceInterface::setTableTopLongitudinalSetupDisplacement	(	unsigned long	idx,
		std::string	parameter
	)

setTableTopVerticalSetupDisplacement()

bool ml::DcmDRTPatientSetupSequenceInterface::setTableTopVerticalSetupDisplacement	(	unsigned long	idx,
		std::string	parameter
	)

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 312 of file mlDcmDRTPatientSetupSequenceInterface.h.

---

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

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