ml::DcmDRTBrachyControlPointSequenceInterface Class Reference

Class to provide access to DRTBrachyControlPointSequence. More...

#include <mlDcmDRTBrachyControlPointSequenceInterface.h>

List of all members.

Public Member Functions
	DcmDRTBrachyControlPointSequenceInterface (DRTBrachyControlPointSequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTBrachyControlPointSequenceInterface ()
	Default virtual Destructor.
bool	getControlPoint3DPosition (unsigned long idx, std::string &parameter)
bool	getControlPoint3DPosition (DRTBrachyControlPointSequence::Item &item, std::string &parameter)
std::string	getControlPoint3DPositionTag () const
bool	setControlPoint3DPosition (unsigned long idx, std::string &parameter)
bool	getControlPointIndex (unsigned long idx, std::string &parameter)
bool	getControlPointIndex (DRTBrachyControlPointSequence::Item &item, std::string &parameter)
std::string	getControlPointIndexTag () const
bool	setControlPointIndex (unsigned long idx, std::string &parameter)
bool	getControlPointRelativePosition (unsigned long idx, std::string &parameter)
bool	getControlPointRelativePosition (DRTBrachyControlPointSequence::Item &item, std::string &parameter)
std::string	getControlPointRelativePositionTag () const
bool	setControlPointRelativePosition (unsigned long idx, std::string &parameter)
bool	getCumulativeTimeWeight (unsigned long idx, std::string &parameter)
bool	getCumulativeTimeWeight (DRTBrachyControlPointSequence::Item &item, std::string &parameter)
std::string	getCumulativeTimeWeightTag () const
bool	setCumulativeTimeWeight (unsigned long idx, std::string &parameter)
DRTBrachyReferencedDoseReferenceSequence &	getBrachyReferencedDoseReferenceSequence (unsigned long idx)
std::string	getBrachyReferencedDoseReferenceSequenceTag () const
void	setSequence (DRTBrachyControlPointSequence *dcmSequence)
	Set the DRTBrachyControlPointSequence this interface class provides access to.
DRTBrachyControlPointSequence *	getSequence () const
	Return the DRTBrachyControlPointSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTBrachyControlPointSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTBrachyControlPointSequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTBrachyControlPointSequence::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
DRTBrachyControlPointSequence *	_dcmSequence
	Reference to the wrapped DcmSequence.

---

Detailed Description

Class to provide access to DRTBrachyControlPointSequence.

Definition at line 43 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

---

Constructor & Destructor Documentation

ml::DcmDRTBrachyControlPointSequenceInterface::DcmDRTBrachyControlPointSequenceInterface

(

DRTBrachyControlPointSequence *

_dcmSequence = NULL

)

[inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

virtual ml::DcmDRTBrachyControlPointSequenceInterface::~DcmDRTBrachyControlPointSequenceInterface

(

)

[inline, virtual]

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

---

Member Function Documentation

DRTBrachyControlPointSequence::Item* ml::DcmDRTBrachyControlPointSequenceInterface::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 118 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

DRTBrachyReferencedDoseReferenceSequence& ml::DcmDRTBrachyControlPointSequenceInterface::getBrachyReferencedDoseReferenceSequence

(

unsigned long

idx

)

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getBrachyReferencedDoseReferenceSequenceTag

(

)

const [inline]

Definition at line 77 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPoint3DPosition	(	DRTBrachyControlPointSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPoint3DPosition	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getControlPoint3DPositionTag

(

)

const [inline]

Definition at line 54 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointIndex	(	DRTBrachyControlPointSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointIndex	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointIndexTag

(

)

const [inline]

Definition at line 60 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointRelativePosition	(	DRTBrachyControlPointSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointRelativePosition	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointRelativePositionTag

(

)

const [inline]

Definition at line 66 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::getCumulativeTimeWeight	(	DRTBrachyControlPointSequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyControlPointSequenceInterface::getCumulativeTimeWeight	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getCumulativeTimeWeightTag

(

)

const [inline]

Definition at line 72 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

DRTBrachyControlPointSequence::Item* ml::DcmDRTBrachyControlPointSequenceInterface::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 109 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

MLint ml::DcmDRTBrachyControlPointSequenceInterface::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 100 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

DRTBrachyControlPointSequence* ml::DcmDRTBrachyControlPointSequenceInterface::getSequence

(

)

const [inline]

Return the DRTBrachyControlPointSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTBrachyControlPointSequence

Definition at line 88 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::hasSequence

(

)

const [inline]

Check if the DRTBrachyControlPointSequence is set.

Returns:

True if internal pointer is set, False else.

Definition at line 94 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::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 129 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::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 140 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

bool ml::DcmDRTBrachyControlPointSequenceInterface::setControlPoint3DPosition	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyControlPointSequenceInterface::setControlPointIndex	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyControlPointSequenceInterface::setControlPointRelativePosition	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTBrachyControlPointSequenceInterface::setCumulativeTimeWeight	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTBrachyControlPointSequenceInterface::setSequence

(

DRTBrachyControlPointSequence *

dcmSequence

)

[inline]

Set the DRTBrachyControlPointSequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTBrachyControlPointSequence

Definition at line 82 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

---

Member Data Documentation

DRTBrachyControlPointSequence* ml::DcmDRTBrachyControlPointSequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 150 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

---

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

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