Class to provide access to DRTFractionStatusSummarySequence. More...

#include <mlDcmDRTFractionStatusSummarySequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTFractionStatusSummarySequenceInterface ()
	DcmDRTFractionStatusSummarySequenceInterface (std::vector< DcmDRTFractionStatusSummarySequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTFractionStatusSummarySequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTFractionStatusSummarySequenceInterface ()
	Default virtual Destructor.
bool	getReferencedFractionNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedFractionNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedFractionNumberTag () const
bool	setReferencedFractionNumber (unsigned long idx, std::string parameter)
bool	getTreatmentDate (unsigned long idx, std::string &parameter) const
bool	getTreatmentDate (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTreatmentDateTag () const
bool	setTreatmentDate (unsigned long idx, std::string parameter)
bool	getTreatmentTerminationStatus (unsigned long idx, std::string &parameter) const
bool	getTreatmentTerminationStatus (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTreatmentTerminationStatusTag () const
bool	setTreatmentTerminationStatus (unsigned long idx, std::string parameter)
bool	getTreatmentTime (unsigned long idx, std::string &parameter) const
bool	getTreatmentTime (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTreatmentTimeTag () const
bool	setTreatmentTime (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTFractionStatusSummarySequenceInterface::Item > dcmSequence)
std::vector< DcmDRTFractionStatusSummarySequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTFractionStatusSummarySequenceInterface::Item	getItem (const size_t idx) const
DcmDRTFractionStatusSummarySequenceInterface::Item &	addItem ()
void	addItem (DcmDRTFractionStatusSummarySequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

Protected Attributes
std::vector< DcmDRTFractionStatusSummarySequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTFractionStatusSummarySequence.

Definition at line 43 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTFractionStatusSummarySequenceInterface() [1/3]

ml::DcmDRTFractionStatusSummarySequenceInterface::DcmDRTFractionStatusSummarySequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

◆ DcmDRTFractionStatusSummarySequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ DcmDRTFractionStatusSummarySequenceInterface() [3/3]

ml::DcmDRTFractionStatusSummarySequenceInterface::DcmDRTFractionStatusSummarySequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ ~DcmDRTFractionStatusSummarySequenceInterface()

virtual ml::DcmDRTFractionStatusSummarySequenceInterface::~DcmDRTFractionStatusSummarySequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTFractionStatusSummarySequenceInterface::Item & ml::DcmDRTFractionStatusSummarySequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns: Return the new item which has been added to the sequence

Definition at line 167 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ getItem()

DcmDRTFractionStatusSummarySequenceInterface::Item ml::DcmDRTFractionStatusSummarySequenceInterface::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 158 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTFractionStatusSummarySequenceInterface::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 152 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ getReferencedFractionNumber() [1/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getReferencedFractionNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getReferencedFractionNumber() [2/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getReferencedFractionNumber	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getReferencedFractionNumberTag()

std::string ml::DcmDRTFractionStatusSummarySequenceInterface::getReferencedFractionNumberTag ( ) const

inline

Definition at line 110 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

◆ getSequence()

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

inline

Return the DRTFractionStatusSummarySequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTFractionStatusSummarySequence

Definition at line 140 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

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

◆ getTreatmentDate() [1/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentDate	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getTreatmentDate() [2/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentDate	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getTreatmentDateTag()

std::string ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentDateTag ( ) const

inline

Definition at line 116 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

◆ getTreatmentTerminationStatus() [1/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentTerminationStatus	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getTreatmentTerminationStatus() [2/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentTerminationStatus	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getTreatmentTerminationStatusTag()

std::string ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentTerminationStatusTag ( ) const

inline

Definition at line 122 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

◆ getTreatmentTime() [1/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentTime	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getTreatmentTime() [2/2]

bool ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentTime	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getTreatmentTimeTag()

std::string ml::DcmDRTFractionStatusSummarySequenceInterface::getTreatmentTimeTag ( ) const

inline

Definition at line 128 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

◆ hasSequence()

bool ml::DcmDRTFractionStatusSummarySequenceInterface::hasSequence ( ) const

inline

Check if the DRTFractionStatusSummarySequence is set.

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

Definition at line 146 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTFractionStatusSummarySequenceInterface::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 178 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTFractionStatusSummarySequenceInterface::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 190 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ setReferencedFractionNumber()

bool ml::DcmDRTFractionStatusSummarySequenceInterface::setReferencedFractionNumber	(	unsigned long	idx,
		std::string	parameter )

◆ setSequence()

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

inline

Set the DRTFractionStatusSummarySequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTFractionStatusSummarySequence

Definition at line 134 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

References _itemVec.

◆ setTreatmentDate()

bool ml::DcmDRTFractionStatusSummarySequenceInterface::setTreatmentDate	(	unsigned long	idx,
		std::string	parameter )

◆ setTreatmentTerminationStatus()

bool ml::DcmDRTFractionStatusSummarySequenceInterface::setTreatmentTerminationStatus	(	unsigned long	idx,
		std::string	parameter )

◆ setTreatmentTime()

bool ml::DcmDRTFractionStatusSummarySequenceInterface::setTreatmentTime	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

◆ _itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTFractionStatusSummarySequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTFractionStatusSummarySequenceInterface(), DcmDRTFractionStatusSummarySequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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

FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTFractionStatusSummarySequenceInterface.h

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTFractionStatusSummarySequenceInterface() [1/3]

◆ DcmDRTFractionStatusSummarySequenceInterface() [2/3]

◆ DcmDRTFractionStatusSummarySequenceInterface() [3/3]

◆ ~DcmDRTFractionStatusSummarySequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getItem()

◆ getNumberOfItems()

◆ getReferencedFractionNumber() [1/2]

◆ getReferencedFractionNumber() [2/2]

◆ getReferencedFractionNumberTag()

◆ getSequence()

◆ getTreatmentDate() [1/2]

◆ getTreatmentDate() [2/2]

◆ getTreatmentDateTag()

◆ getTreatmentTerminationStatus() [1/2]

◆ getTreatmentTerminationStatus() [2/2]

◆ getTreatmentTerminationStatusTag()

◆ getTreatmentTime() [1/2]

◆ getTreatmentTime() [2/2]

◆ getTreatmentTimeTag()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setReferencedFractionNumber()

◆ setSequence()

◆ setTreatmentDate()

◆ setTreatmentTerminationStatus()

◆ setTreatmentTime()

Member Data Documentation

◆ _itemVec