ml::DcmDRTFractionGroupSummarySequenceInterface Class Reference

Class to provide access to DRTFractionGroupSummarySequence. More...

#include <mlDcmDRTFractionGroupSummarySequenceInterface.h>

List of all members.

Public Member Functions

DcmDRTFractionGroupSummarySequenceInterface (DRTFractionGroupSummarySequence *_dcmSequence=NULL)

Default Constructor.

virtual ~DcmDRTFractionGroupSummarySequenceInterface ()

Default virtual Destructor.

bool getCumulativeDoseToDoseReference (unsigned long idx, std::string &parameter)

bool getCumulativeDoseToDoseReference (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)

std::string getCumulativeDoseToDoseReferenceTag () const

bool setCumulativeDoseToDoseReference (unsigned long idx, std::string &parameter)

bool getDoseReferenceDescription (unsigned long idx, std::string &parameter)

bool getDoseReferenceDescription (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)

std::string getDoseReferenceDescriptionTag () const

bool setDoseReferenceDescription (unsigned long idx, std::string &parameter)

bool getFractionGroupType (unsigned long idx, std::string &parameter)

bool getFractionGroupType (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)

std::string getFractionGroupTypeTag () const

bool setFractionGroupType (unsigned long idx, std::string &parameter)

bool getNumberOfFractionsDelivered (unsigned long idx, std::string &parameter)

bool getNumberOfFractionsDelivered (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)

std::string getNumberOfFractionsDeliveredTag () const

bool setNumberOfFractionsDelivered (unsigned long idx, std::string &parameter)

bool getNumberOfFractionsPlanned (unsigned long idx, std::string &parameter)

bool getNumberOfFractionsPlanned (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)

std::string getNumberOfFractionsPlannedTag () const

bool setNumberOfFractionsPlanned (unsigned long idx, std::string &parameter)

bool getReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)

bool getReferencedDoseReferenceNumber (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)

std::string getReferencedDoseReferenceNumberTag () const

bool setReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)

bool getReferencedFractionGroupNumber (unsigned long idx, std::string &parameter)

bool getReferencedFractionGroupNumber (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)

std::string getReferencedFractionGroupNumberTag () const

bool setReferencedFractionGroupNumber (unsigned long idx, std::string &parameter)

DRTFractionStatusSummarySequence & getFractionStatusSummarySequence (unsigned long idx)

std::string getFractionStatusSummarySequenceTag () const

void setSequence (DRTFractionGroupSummarySequence *dcmSequence)

Set the DRTFractionGroupSummarySequence this interface class provides access to.

DRTFractionGroupSummarySequence * getSequence () const

Return the DRTFractionGroupSummarySequence this interface class provides access to.

bool hasSequence () const

Check if the DRTFractionGroupSummarySequence is set.

MLint getNumberOfItems () const

Return number of items the internal sequence consists of.

DRTFractionGroupSummarySequence::Item * getItem (const unsigned long idx)

Return number of items the internal sequence consists of.

DRTFractionGroupSummarySequence::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

DRTFractionGroupSummarySequence * _dcmSequence

Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTFractionGroupSummarySequence.

Definition at line 43 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTFractionGroupSummarySequenceInterface::DcmDRTFractionGroupSummarySequenceInterface ( DRTFractionGroupSummarySequence * _dcmSequence = NULL ) [inline]

Default Constructor.

Definition at line 47 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

virtual ml::DcmDRTFractionGroupSummarySequenceInterface::~DcmDRTFractionGroupSummarySequenceInterface ( ) [inline, virtual]

Default virtual Destructor.

Definition at line 50 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

Member Function Documentation

DRTFractionGroupSummarySequence::Item* ml::DcmDRTFractionGroupSummarySequenceInterface::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 136 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getCumulativeDoseToDoseReference	(	DRTFractionGroupSummarySequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getCumulativeDoseToDoseReference	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getCumulativeDoseToDoseReferenceTag ( ) const [inline]

Definition at line 54 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getDoseReferenceDescription	(	DRTFractionGroupSummarySequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getDoseReferenceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getDoseReferenceDescriptionTag ( ) const [inline]

Definition at line 60 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionGroupType	(	DRTFractionGroupSummarySequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionGroupType	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionGroupTypeTag ( ) const [inline]

Definition at line 66 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

DRTFractionStatusSummarySequence& ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionStatusSummarySequence ( unsigned long idx )

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getFractionStatusSummarySequenceTag ( ) const [inline]

Definition at line 95 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

DRTFractionGroupSummarySequence::Item* ml::DcmDRTFractionGroupSummarySequenceInterface::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 127 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsDelivered	(	DRTFractionGroupSummarySequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsDelivered	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsDeliveredTag ( ) const [inline]

Definition at line 72 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsPlanned	(	DRTFractionGroupSummarySequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsPlanned	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getNumberOfFractionsPlannedTag ( ) const [inline]

Definition at line 78 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

MLint ml::DcmDRTFractionGroupSummarySequenceInterface::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 118 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedDoseReferenceNumber	(	DRTFractionGroupSummarySequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedDoseReferenceNumberTag ( ) const [inline]

Definition at line 84 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedFractionGroupNumber	(	DRTFractionGroupSummarySequence::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedFractionGroupNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSummarySequenceInterface::getReferencedFractionGroupNumberTag ( ) const [inline]

Definition at line 90 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

DRTFractionGroupSummarySequence* ml::DcmDRTFractionGroupSummarySequenceInterface::getSequence ( ) const [inline]

Return the DRTFractionGroupSummarySequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTFractionGroupSummarySequence

Definition at line 106 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::hasSequence ( ) const [inline]

Check if the DRTFractionGroupSummarySequence is set.

Returns:: True if internal pointer is set, False else.

Definition at line 112 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::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 147 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::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 158 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setCumulativeDoseToDoseReference	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setDoseReferenceDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setFractionGroupType	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setNumberOfFractionsDelivered	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setNumberOfFractionsPlanned	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setReferencedDoseReferenceNumber	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSummarySequenceInterface::setReferencedFractionGroupNumber	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTFractionGroupSummarySequenceInterface::setSequence ( DRTFractionGroupSummarySequence * dcmSequence ) [inline]

Set the DRTFractionGroupSummarySequence this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTFractionGroupSummarySequence

Definition at line 100 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

Member Data Documentation

DRTFractionGroupSummarySequence* ml::DcmDRTFractionGroupSummarySequenceInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 168 of file mlDcmDRTFractionGroupSummarySequenceInterface.h.

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

FMEwork/Release/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTFractionGroupSummarySequenceInterface.h


Public Member Functions
	DcmDRTFractionGroupSummarySequenceInterface (DRTFractionGroupSummarySequence *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTFractionGroupSummarySequenceInterface ()
	Default virtual Destructor.
bool	getCumulativeDoseToDoseReference (unsigned long idx, std::string &parameter)
bool	getCumulativeDoseToDoseReference (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)
std::string	getCumulativeDoseToDoseReferenceTag () const
bool	setCumulativeDoseToDoseReference (unsigned long idx, std::string &parameter)
bool	getDoseReferenceDescription (unsigned long idx, std::string &parameter)
bool	getDoseReferenceDescription (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)
std::string	getDoseReferenceDescriptionTag () const
bool	setDoseReferenceDescription (unsigned long idx, std::string &parameter)
bool	getFractionGroupType (unsigned long idx, std::string &parameter)
bool	getFractionGroupType (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)
std::string	getFractionGroupTypeTag () const
bool	setFractionGroupType (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionsDelivered (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionsDelivered (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)
std::string	getNumberOfFractionsDeliveredTag () const
bool	setNumberOfFractionsDelivered (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionsPlanned (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionsPlanned (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)
std::string	getNumberOfFractionsPlannedTag () const
bool	setNumberOfFractionsPlanned (unsigned long idx, std::string &parameter)
bool	getReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)
bool	getReferencedDoseReferenceNumber (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)
std::string	getReferencedDoseReferenceNumberTag () const
bool	setReferencedDoseReferenceNumber (unsigned long idx, std::string &parameter)
bool	getReferencedFractionGroupNumber (unsigned long idx, std::string &parameter)
bool	getReferencedFractionGroupNumber (DRTFractionGroupSummarySequence::Item &item, std::string &parameter)
std::string	getReferencedFractionGroupNumberTag () const
bool	setReferencedFractionGroupNumber (unsigned long idx, std::string &parameter)
DRTFractionStatusSummarySequence &	getFractionStatusSummarySequence (unsigned long idx)
std::string	getFractionStatusSummarySequenceTag () const
void	setSequence (DRTFractionGroupSummarySequence *dcmSequence)
	Set the DRTFractionGroupSummarySequence this interface class provides access to.
DRTFractionGroupSummarySequence *	getSequence () const
	Return the DRTFractionGroupSummarySequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTFractionGroupSummarySequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTFractionGroupSummarySequence::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTFractionGroupSummarySequence::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
DRTFractionGroupSummarySequence *	_dcmSequence
	Reference to the wrapped DcmSequence.