ml::DcmDRTPatientSetupSequenceInterface Class Reference

Class to provide access to DRTPatientSetupSequence. More...

#include <mlDcmDRTPatientSetupSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTPatientSetupSequenceInterface (DRTPatientSetupSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTPatientSetupSequenceInterface ()
	Default virtual Destructor.
bool	getPatientAdditionalPosition (unsigned long idx, std::string &parameter)
bool	getPatientAdditionalPosition (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getPatientAdditionalPositionTag () const
bool	setPatientAdditionalPosition (unsigned long idx, std::string &parameter)
bool	getPatientPosition (unsigned long idx, std::string &parameter)
bool	getPatientPosition (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getPatientPositionTag () const
bool	setPatientPosition (unsigned long idx, std::string &parameter)
bool	getPatientSetupLabel (unsigned long idx, std::string &parameter)
bool	getPatientSetupLabel (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getPatientSetupLabelTag () const
bool	setPatientSetupLabel (unsigned long idx, std::string &parameter)
bool	getPatientSetupNumber (unsigned long idx, std::string &parameter)
bool	getPatientSetupNumber (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getPatientSetupNumberTag () const
bool	setPatientSetupNumber (unsigned long idx, std::string &parameter)
bool	getSetupTechnique (unsigned long idx, std::string &parameter)
bool	getSetupTechnique (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getSetupTechniqueTag () const
bool	setSetupTechnique (unsigned long idx, std::string &parameter)
bool	getSetupTechniqueDescription (unsigned long idx, std::string &parameter)
bool	getSetupTechniqueDescription (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getSetupTechniqueDescriptionTag () const
bool	setSetupTechniqueDescription (unsigned long idx, std::string &parameter)
bool	getTableTopLateralSetupDisplacement (unsigned long idx, std::string &parameter)
bool	getTableTopLateralSetupDisplacement (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getTableTopLateralSetupDisplacementTag () const
bool	setTableTopLateralSetupDisplacement (unsigned long idx, std::string &parameter)
bool	getTableTopLongitudinalSetupDisplacement (unsigned long idx, std::string &parameter)
bool	getTableTopLongitudinalSetupDisplacement (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getTableTopLongitudinalSetupDisplacementTag () const
bool	setTableTopLongitudinalSetupDisplacement (unsigned long idx, std::string &parameter)
bool	getTableTopVerticalSetupDisplacement (unsigned long idx, std::string &parameter)
bool	getTableTopVerticalSetupDisplacement (DRTPatientSetupSequence::Item &item, std::string &parameter)
std::string	getTableTopVerticalSetupDisplacementTag () const
bool	setTableTopVerticalSetupDisplacement (unsigned long idx, std::string &parameter)
DRTFixationDeviceSequence &	getFixationDeviceSequence (unsigned long idx)
std::string	getFixationDeviceSequenceTag () const
DRTMotionSynchronizationSequence &	getMotionSynchronizationSequence (unsigned long idx)
std::string	getMotionSynchronizationSequenceTag () const
DRTReferencedSetupImageSequence &	getReferencedSetupImageSequence (unsigned long idx)
std::string	getReferencedSetupImageSequenceTag () const
DRTSetupDeviceSequence &	getSetupDeviceSequence (unsigned long idx)
std::string	getSetupDeviceSequenceTag () const
DRTShieldingDeviceSequence &	getShieldingDeviceSequence (unsigned long idx)
std::string	getShieldingDeviceSequenceTag () const
void	setSequence (DRTPatientSetupSequence *dcmSequence)
	Set the DRTPatientSetupSequence this interface class provides access to.
DRTPatientSetupSequence *	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.
DRTPatientSetupSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTPatientSetupSequence::Item *	addItem ()
	Return number of items the internal sequence consists of.
bool	insertItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
bool	removeItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
Protected Attributes
DRTPatientSetupSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTPatientSetupSequence.

Definition at line 47 of file mlDcmDRTPatientSetupSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTPatientSetupSequenceInterface::DcmDRTPatientSetupSequenceInterface

(

DRTPatientSetupSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 51 of file mlDcmDRTPatientSetupSequenceInterface.h.

virtual ml::DcmDRTPatientSetupSequenceInterface::~DcmDRTPatientSetupSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 54 of file mlDcmDRTPatientSetupSequenceInterface.h.

---

Member Function Documentation

DRTPatientSetupSequence::Item* ml::DcmDRTPatientSetupSequenceInterface::addItem

(

)

[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 168 of file mlDcmDRTPatientSetupSequenceInterface.h.

DRTFixationDeviceSequence& ml::DcmDRTPatientSetupSequenceInterface::getFixationDeviceSequence

(

unsigned long

idx

)

std::string ml::DcmDRTPatientSetupSequenceInterface::getFixationDeviceSequenceTag

(

)

const [inline]

Definition at line 111 of file mlDcmDRTPatientSetupSequenceInterface.h.

DRTPatientSetupSequence::Item* ml::DcmDRTPatientSetupSequenceInterface::getItem

(

const unsigned long

idx

)

[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 159 of file mlDcmDRTPatientSetupSequenceInterface.h.

DRTMotionSynchronizationSequence& ml::DcmDRTPatientSetupSequenceInterface::getMotionSynchronizationSequence

(

unsigned long

idx

)

std::string ml::DcmDRTPatientSetupSequenceInterface::getMotionSynchronizationSequenceTag

(

)

const [inline]

Definition at line 115 of file mlDcmDRTPatientSetupSequenceInterface.h.

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 150 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientAdditionalPosition	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientAdditionalPositionTag

(

)

const [inline]

Definition at line 58 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientPosition	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientPositionTag

(

)

const [inline]

Definition at line 64 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupLabel	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupLabelTag

(

)

const [inline]

Definition at line 70 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupNumber	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getPatientSetupNumberTag

(

)

const [inline]

Definition at line 76 of file mlDcmDRTPatientSetupSequenceInterface.h.

DRTReferencedSetupImageSequence& ml::DcmDRTPatientSetupSequenceInterface::getReferencedSetupImageSequence

(

unsigned long

idx

)

std::string ml::DcmDRTPatientSetupSequenceInterface::getReferencedSetupImageSequenceTag

(

)

const [inline]

Definition at line 119 of file mlDcmDRTPatientSetupSequenceInterface.h.

DRTPatientSetupSequence* ml::DcmDRTPatientSetupSequenceInterface::getSequence

(

)

const [inline]

Return the DRTPatientSetupSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTPatientSetupSequence

Definition at line 138 of file mlDcmDRTPatientSetupSequenceInterface.h.

DRTSetupDeviceSequence& ml::DcmDRTPatientSetupSequenceInterface::getSetupDeviceSequence

(

unsigned long

idx

)

std::string ml::DcmDRTPatientSetupSequenceInterface::getSetupDeviceSequenceTag

(

)

const [inline]

Definition at line 123 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getSetupTechnique	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

bool ml::DcmDRTPatientSetupSequenceInterface::getSetupTechniqueDescription	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getSetupTechniqueDescriptionTag

(

)

const [inline]

Definition at line 88 of file mlDcmDRTPatientSetupSequenceInterface.h.

std::string ml::DcmDRTPatientSetupSequenceInterface::getSetupTechniqueTag

(

)

const [inline]

Definition at line 82 of file mlDcmDRTPatientSetupSequenceInterface.h.

DRTShieldingDeviceSequence& ml::DcmDRTPatientSetupSequenceInterface::getShieldingDeviceSequence

(

unsigned long

idx

)

std::string ml::DcmDRTPatientSetupSequenceInterface::getShieldingDeviceSequenceTag

(

)

const [inline]

Definition at line 127 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopLateralSetupDisplacement	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getTableTopLateralSetupDisplacementTag

(

)

const [inline]

Definition at line 94 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopLongitudinalSetupDisplacement	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getTableTopLongitudinalSetupDisplacementTag

(

)

const [inline]

Definition at line 100 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::getTableTopVerticalSetupDisplacement	(	DRTPatientSetupSequence::Item &	item,
		std::string &	parameter
	)

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

std::string ml::DcmDRTPatientSetupSequenceInterface::getTableTopVerticalSetupDisplacementTag

(

)

const [inline]

Definition at line 106 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTPatientSetupSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 144 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::insertItem

(

const unsigned long

idx

)

[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 179 of file mlDcmDRTPatientSetupSequenceInterface.h.

bool ml::DcmDRTPatientSetupSequenceInterface::removeItem

(

const unsigned long

idx

)

[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 190 of file mlDcmDRTPatientSetupSequenceInterface.h.

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

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

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

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

void ml::DcmDRTPatientSetupSequenceInterface::setSequence

(

DRTPatientSetupSequence *

dcmSequence

)

[inline]

Set the DRTPatientSetupSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTPatientSetupSequence

Definition at line 132 of file mlDcmDRTPatientSetupSequenceInterface.h.

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

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

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

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

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

---

Member Data Documentation

DRTPatientSetupSequence* ml::DcmDRTPatientSetupSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 200 of file mlDcmDRTPatientSetupSequenceInterface.h.

---

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

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