Class to provide access to DRTBrachyControlPointSequence. More...

#include <mlDcmDRTBrachyControlPointSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTBrachyControlPointSequenceInterface ()
	DcmDRTBrachyControlPointSequenceInterface (std::vector< DcmDRTBrachyControlPointSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTBrachyControlPointSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTBrachyControlPointSequenceInterface ()
	Default virtual Destructor.
bool	getControlPoint3DPosition (unsigned long idx, std::string &parameter) const
bool	getControlPoint3DPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getControlPoint3DPositionTag () const
bool	setControlPoint3DPosition (unsigned long idx, std::string parameter)
bool	getControlPointIndex (unsigned long idx, std::string &parameter) const
bool	getControlPointIndex (DCMTree::TreePtr item, std::string &parameter) const
std::string	getControlPointIndexTag () const
bool	setControlPointIndex (unsigned long idx, std::string parameter)
bool	getControlPointRelativePosition (unsigned long idx, std::string &parameter) const
bool	getControlPointRelativePosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getControlPointRelativePositionTag () const
bool	setControlPointRelativePosition (unsigned long idx, std::string parameter)
bool	getCumulativeTimeWeight (unsigned long idx, std::string &parameter) const
bool	getCumulativeTimeWeight (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCumulativeTimeWeightTag () const
bool	setCumulativeTimeWeight (unsigned long idx, std::string parameter)
DcmDRTBrachyReferencedDoseReferenceSequenceInterface	getBrachyReferencedDoseReferenceSequence (unsigned long idx) const
std::string	getBrachyReferencedDoseReferenceSequenceTag () const
void	setBrachyReferencedDoseReferenceSequence (DcmDRTBrachyReferencedDoseReferenceSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTBrachyControlPointSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTBrachyControlPointSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTBrachyControlPointSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTBrachyControlPointSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTBrachyControlPointSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTBrachyControlPointSequence.

Definition at line 44 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTBrachyControlPointSequenceInterface() [1/3]

ml::DcmDRTBrachyControlPointSequenceInterface::DcmDRTBrachyControlPointSequenceInterface ( )

inline

Definition at line 99 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

◆ DcmDRTBrachyControlPointSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 102 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

◆ DcmDRTBrachyControlPointSequenceInterface() [3/3]

ml::DcmDRTBrachyControlPointSequenceInterface::DcmDRTBrachyControlPointSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 104 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTBrachyControlPointSequenceInterface()

virtual ml::DcmDRTBrachyControlPointSequenceInterface::~DcmDRTBrachyControlPointSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 112 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTBrachyControlPointSequenceInterface::Item & ml::DcmDRTBrachyControlPointSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

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

Definition at line 178 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

inline

Definition at line 183 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

◆ getBrachyReferencedDoseReferenceSequence()

DcmDRTBrachyReferencedDoseReferenceSequenceInterface ml::DcmDRTBrachyControlPointSequenceInterface::getBrachyReferencedDoseReferenceSequence ( unsigned long idx ) const

◆ getBrachyReferencedDoseReferenceSequenceTag()

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getBrachyReferencedDoseReferenceSequenceTag ( ) const

inline

Definition at line 139 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

◆ getControlPoint3DPosition() [1/2]

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPoint3DPosition	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getControlPoint3DPosition() [2/2]

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

◆ getControlPoint3DPositionTag()

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getControlPoint3DPositionTag ( ) const

inline

Definition at line 116 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

◆ getControlPointIndex() [1/2]

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointIndex	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getControlPointIndex() [2/2]

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

◆ getControlPointIndexTag()

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointIndexTag ( ) const

inline

Definition at line 122 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

◆ getControlPointRelativePosition() [1/2]

bool ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointRelativePosition	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getControlPointRelativePosition() [2/2]

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

◆ getControlPointRelativePositionTag()

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getControlPointRelativePositionTag ( ) const

inline

Definition at line 128 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

◆ getCumulativeTimeWeight() [1/2]

bool ml::DcmDRTBrachyControlPointSequenceInterface::getCumulativeTimeWeight	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getCumulativeTimeWeight() [2/2]

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

◆ getCumulativeTimeWeightTag()

std::string ml::DcmDRTBrachyControlPointSequenceInterface::getCumulativeTimeWeightTag ( ) const

inline

Definition at line 134 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

◆ getItem()

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

References _itemVec.

◆ getNumberOfItems()

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 163 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

◆ getSequence()

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

inline

Return the DRTBrachyControlPointSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTBrachyControlPointSequence

Definition at line 151 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

bool ml::DcmDRTBrachyControlPointSequenceInterface::hasSequence ( ) const

inline

Check if the DRTBrachyControlPointSequence is set.

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

Definition at line 157 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

◆ insertItem()

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

References _itemVec.

◆ removeItem()

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

References _itemVec.

◆ setBrachyReferencedDoseReferenceSequence()

void ml::DcmDRTBrachyControlPointSequenceInterface::setBrachyReferencedDoseReferenceSequence	(	DcmDRTBrachyReferencedDoseReferenceSequenceInterface	seq,
		unsigned long	idx )

◆ setControlPoint3DPosition()

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

◆ setControlPointIndex()

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

◆ setControlPointRelativePosition()

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

◆ setCumulativeTimeWeight()

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

◆ setSequence()

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

inline

Set the DRTBrachyControlPointSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTBrachyControlPointSequence

Definition at line 145 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTBrachyControlPointSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTBrachyControlPointSequenceInterface(), DcmDRTBrachyControlPointSequenceInterface(), 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/mlDcmDRTBrachyControlPointSequenceInterface.h

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTBrachyControlPointSequenceInterface() [1/3]

◆ DcmDRTBrachyControlPointSequenceInterface() [2/3]

◆ DcmDRTBrachyControlPointSequenceInterface() [3/3]

◆ ~DcmDRTBrachyControlPointSequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getBrachyReferencedDoseReferenceSequence()

◆ getBrachyReferencedDoseReferenceSequenceTag()

◆ getControlPoint3DPosition() [1/2]

◆ getControlPoint3DPosition() [2/2]

◆ getControlPoint3DPositionTag()

◆ getControlPointIndex() [1/2]

◆ getControlPointIndex() [2/2]

◆ getControlPointIndexTag()

◆ getControlPointRelativePosition() [1/2]

◆ getControlPointRelativePosition() [2/2]

◆ getControlPointRelativePositionTag()

◆ getCumulativeTimeWeight() [1/2]

◆ getCumulativeTimeWeight() [2/2]

◆ getCumulativeTimeWeightTag()

◆ getItem()

◆ getNumberOfItems()

◆ getSequence()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setBrachyReferencedDoseReferenceSequence()

◆ setControlPoint3DPosition()

◆ setControlPointIndex()

◆ setControlPointRelativePosition()

◆ setCumulativeTimeWeight()

◆ setSequence()

Member Data Documentation

◆ _itemVec