ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface Class Reference

Class to provide access to DRTFractionGroupSequenceInRTPlanIOD. More...

#include <mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h>

List of all members.

Public Member Functions

DcmDRTFractionGroupSequenceInRTPlanIODInterface (DRTFractionGroupSequenceInRTPlanIOD *_dcmSequence=NULL)

Default Constructor.

virtual ~DcmDRTFractionGroupSequenceInRTPlanIODInterface ()

Default virtual Destructor.

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

bool getFractionGroupDescription (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getFractionGroupDescriptionTag () const

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

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

bool getFractionGroupNumber (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getFractionGroupNumberTag () const

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

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

bool getFractionPattern (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getFractionPatternTag () const

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

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

bool getNumberOfBeams (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getNumberOfBeamsTag () const

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

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

bool getNumberOfBrachyApplicationSetups (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getNumberOfBrachyApplicationSetupsTag () const

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

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

bool getNumberOfFractionPatternDigitsPerDay (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getNumberOfFractionPatternDigitsPerDayTag () const

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

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

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

std::string getNumberOfFractionsPlannedTag () const

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

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

bool getRepeatFractionCycleLength (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)

std::string getRepeatFractionCycleLengthTag () const

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

DRTReferencedBeamSequenceInRTPlanIOD & getReferencedBeamSequence (unsigned long idx)

std::string getReferencedBeamSequenceTag () const

DRTReferencedBrachyApplicationSetupSequenceInRTPlanIOD & getReferencedBrachyApplicationSetupSequence (unsigned long idx)

std::string getReferencedBrachyApplicationSetupSequenceTag () const

DRTReferencedDoseReferenceSequence & getReferencedDoseReferenceSequence (unsigned long idx)

std::string getReferencedDoseReferenceSequenceTag () const

DRTReferencedDoseSequence & getReferencedDoseSequence (unsigned long idx)

std::string getReferencedDoseSequenceTag () const

void setSequence (DRTFractionGroupSequenceInRTPlanIOD *dcmSequence)

Set the DRTFractionGroupSequenceInRTPlanIOD this interface class provides access to.

DRTFractionGroupSequenceInRTPlanIOD * getSequence () const

Return the DRTFractionGroupSequenceInRTPlanIOD this interface class provides access to.

bool hasSequence () const

Check if the DRTFractionGroupSequenceInRTPlanIOD is set.

MLint getNumberOfItems () const

Return number of items the internal sequence consists of.

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

Return number of items the internal sequence consists of.

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

DRTFractionGroupSequenceInRTPlanIOD * _dcmSequence

Reference to the wrapped DcmSequence.

Detailed Description

Class to provide access to DRTFractionGroupSequenceInRTPlanIOD.

Definition at line 46 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

Constructor & Destructor Documentation

ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::DcmDRTFractionGroupSequenceInRTPlanIODInterface ( DRTFractionGroupSequenceInRTPlanIOD * _dcmSequence = NULL ) [inline]

Default Constructor.

Definition at line 50 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

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

Default virtual Destructor.

Definition at line 53 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

Member Function Documentation

DRTFractionGroupSequenceInRTPlanIOD::Item* ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::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 157 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionGroupDescription	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionGroupDescription	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionGroupDescriptionTag ( ) const [inline]

Definition at line 57 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionGroupNumber	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionGroupNumber	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionGroupNumberTag ( ) const [inline]

Definition at line 63 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionPattern	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionPattern	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getFractionPatternTag ( ) const [inline]

Definition at line 69 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

DRTFractionGroupSequenceInRTPlanIOD::Item* ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::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 148 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfBeams	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfBeams	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfBeamsTag ( ) const [inline]

Definition at line 75 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfBrachyApplicationSetups	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfBrachyApplicationSetups	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfBrachyApplicationSetupsTag ( ) const [inline]

Definition at line 81 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfFractionPatternDigitsPerDay	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfFractionPatternDigitsPerDay	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfFractionPatternDigitsPerDayTag ( ) const [inline]

Definition at line 87 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getNumberOfFractionsPlanned	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

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

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

Definition at line 93 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

MLint ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::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 139 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

DRTReferencedBeamSequenceInRTPlanIOD& ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedBeamSequence ( unsigned long idx )

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedBeamSequenceTag ( ) const [inline]

Definition at line 104 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

DRTReferencedBrachyApplicationSetupSequenceInRTPlanIOD& ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedBrachyApplicationSetupSequence ( unsigned long idx )

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedBrachyApplicationSetupSequenceTag ( ) const [inline]

Definition at line 108 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

DRTReferencedDoseReferenceSequence& ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedDoseReferenceSequence ( unsigned long idx )

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedDoseReferenceSequenceTag ( ) const [inline]

Definition at line 112 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

DRTReferencedDoseSequence& ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedDoseSequence ( unsigned long idx )

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getReferencedDoseSequenceTag ( ) const [inline]

Definition at line 116 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getRepeatFractionCycleLength	(	DRTFractionGroupSequenceInRTPlanIOD::Item &	item,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getRepeatFractionCycleLength	(	unsigned long	idx,
		std::string &	parameter
	)

std::string ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getRepeatFractionCycleLengthTag ( ) const [inline]

Definition at line 99 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

DRTFractionGroupSequenceInRTPlanIOD* ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::getSequence ( ) const [inline]

Return the DRTFractionGroupSequenceInRTPlanIOD this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTFractionGroupSequenceInRTPlanIOD

Definition at line 127 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

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

Check if the DRTFractionGroupSequenceInRTPlanIOD is set.

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

Definition at line 133 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::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 168 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::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 179 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setFractionGroupDescription	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setFractionGroupNumber	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setFractionPattern	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setNumberOfBeams	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setNumberOfBrachyApplicationSetups	(	unsigned long	idx,
		std::string &	parameter
	)

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setNumberOfFractionPatternDigitsPerDay	(	unsigned long	idx,
		std::string &	parameter
	)

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

bool ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setRepeatFractionCycleLength	(	unsigned long	idx,
		std::string &	parameter
	)

void ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::setSequence ( DRTFractionGroupSequenceInRTPlanIOD * dcmSequence ) [inline]

Set the DRTFractionGroupSequenceInRTPlanIOD this interface class provides access to.

Parameters:

dcmSequence

Pointer to DRTFractionGroupSequenceInRTPlanIOD

Definition at line 121 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

Member Data Documentation

DRTFractionGroupSequenceInRTPlanIOD* ml::DcmDRTFractionGroupSequenceInRTPlanIODInterface::_dcmSequence [protected]

Reference to the wrapped DcmSequence.

Definition at line 189 of file mlDcmDRTFractionGroupSequenceInRTPlanIODInterface.h.

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

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


Public Member Functions
	DcmDRTFractionGroupSequenceInRTPlanIODInterface (DRTFractionGroupSequenceInRTPlanIOD *_dcmSequence=NULL)
	Default Constructor.
virtual	~DcmDRTFractionGroupSequenceInRTPlanIODInterface ()
	Default virtual Destructor.
bool	getFractionGroupDescription (unsigned long idx, std::string &parameter)
bool	getFractionGroupDescription (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getFractionGroupDescriptionTag () const
bool	setFractionGroupDescription (unsigned long idx, std::string &parameter)
bool	getFractionGroupNumber (unsigned long idx, std::string &parameter)
bool	getFractionGroupNumber (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getFractionGroupNumberTag () const
bool	setFractionGroupNumber (unsigned long idx, std::string &parameter)
bool	getFractionPattern (unsigned long idx, std::string &parameter)
bool	getFractionPattern (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getFractionPatternTag () const
bool	setFractionPattern (unsigned long idx, std::string &parameter)
bool	getNumberOfBeams (unsigned long idx, std::string &parameter)
bool	getNumberOfBeams (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getNumberOfBeamsTag () const
bool	setNumberOfBeams (unsigned long idx, std::string &parameter)
bool	getNumberOfBrachyApplicationSetups (unsigned long idx, std::string &parameter)
bool	getNumberOfBrachyApplicationSetups (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getNumberOfBrachyApplicationSetupsTag () const
bool	setNumberOfBrachyApplicationSetups (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionPatternDigitsPerDay (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionPatternDigitsPerDay (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getNumberOfFractionPatternDigitsPerDayTag () const
bool	setNumberOfFractionPatternDigitsPerDay (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionsPlanned (unsigned long idx, std::string &parameter)
bool	getNumberOfFractionsPlanned (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getNumberOfFractionsPlannedTag () const
bool	setNumberOfFractionsPlanned (unsigned long idx, std::string &parameter)
bool	getRepeatFractionCycleLength (unsigned long idx, std::string &parameter)
bool	getRepeatFractionCycleLength (DRTFractionGroupSequenceInRTPlanIOD::Item &item, std::string &parameter)
std::string	getRepeatFractionCycleLengthTag () const
bool	setRepeatFractionCycleLength (unsigned long idx, std::string &parameter)
DRTReferencedBeamSequenceInRTPlanIOD &	getReferencedBeamSequence (unsigned long idx)
std::string	getReferencedBeamSequenceTag () const
DRTReferencedBrachyApplicationSetupSequenceInRTPlanIOD &	getReferencedBrachyApplicationSetupSequence (unsigned long idx)
std::string	getReferencedBrachyApplicationSetupSequenceTag () const
DRTReferencedDoseReferenceSequence &	getReferencedDoseReferenceSequence (unsigned long idx)
std::string	getReferencedDoseReferenceSequenceTag () const
DRTReferencedDoseSequence &	getReferencedDoseSequence (unsigned long idx)
std::string	getReferencedDoseSequenceTag () const
void	setSequence (DRTFractionGroupSequenceInRTPlanIOD *dcmSequence)
	Set the DRTFractionGroupSequenceInRTPlanIOD this interface class provides access to.
DRTFractionGroupSequenceInRTPlanIOD *	getSequence () const
	Return the DRTFractionGroupSequenceInRTPlanIOD this interface class provides access to.
bool	hasSequence () const
	Check if the DRTFractionGroupSequenceInRTPlanIOD is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DRTFractionGroupSequenceInRTPlanIOD::Item *	getItem (const unsigned long idx)
	Return number of items the internal sequence consists of.
DRTFractionGroupSequenceInRTPlanIOD::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
DRTFractionGroupSequenceInRTPlanIOD *	_dcmSequence
	Reference to the wrapped DcmSequence.