ml::DcmDRTContourSequenceInterface Class Reference

Class to provide access to DRTContourSequence. More...

#include <mlDcmDRTContourSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTContourSequenceInterface ()
	DcmDRTContourSequenceInterface (std::vector< DcmDRTContourSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTContourSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTContourSequenceInterface ()
	Default virtual Destructor.
bool	getAttachedContours (unsigned long idx, std::string &parameter) const
bool	getAttachedContours (DCMTree::TreePtr item, std::string &parameter) const
std::string	getAttachedContoursTag () const
bool	setAttachedContours (unsigned long idx, std::string parameter)
bool	getContourData (unsigned long idx, std::string &parameter) const
bool	getContourData (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContourDataTag () const
bool	setContourData (unsigned long idx, std::string parameter)
bool	getContourGeometricType (unsigned long idx, std::string &parameter) const
bool	getContourGeometricType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContourGeometricTypeTag () const
bool	setContourGeometricType (unsigned long idx, std::string parameter)
bool	getContourNumber (unsigned long idx, std::string &parameter) const
bool	getContourNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContourNumberTag () const
bool	setContourNumber (unsigned long idx, std::string parameter)
bool	getContourOffsetVector (unsigned long idx, std::string &parameter) const
bool	getContourOffsetVector (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContourOffsetVectorTag () const
bool	setContourOffsetVector (unsigned long idx, std::string parameter)
bool	getContourSlabThickness (unsigned long idx, std::string &parameter) const
bool	getContourSlabThickness (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContourSlabThicknessTag () const
bool	setContourSlabThickness (unsigned long idx, std::string parameter)
bool	getNumberOfContourPoints (unsigned long idx, std::string &parameter) const
bool	getNumberOfContourPoints (DCMTree::TreePtr item, std::string &parameter) const
std::string	getNumberOfContourPointsTag () const
bool	setNumberOfContourPoints (unsigned long idx, std::string parameter)
DcmDRTContourImageSequenceInterface	getContourImageSequence (unsigned long idx) const
std::string	getContourImageSequenceTag () const
void	setContourImageSequence (DcmDRTContourImageSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTContourSequenceInterface::Item > dcmSequence)
	Set the DRTContourSequence this interface class provides access to.
std::vector< DcmDRTContourSequenceInterface::Item >	getSequence () const
	Return the DRTContourSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTContourSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTContourSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTContourSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTContourSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position.
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence.

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

Detailed Description

Class to provide access to DRTContourSequence.

Definition at line 44 of file mlDcmDRTContourSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTContourSequenceInterface() [1/3]

ml::DcmDRTContourSequenceInterface::DcmDRTContourSequenceInterface ( )

inline

Definition at line 114 of file mlDcmDRTContourSequenceInterface.h.

DcmDRTContourSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 117 of file mlDcmDRTContourSequenceInterface.h.

DcmDRTContourSequenceInterface() [3/3]

ml::DcmDRTContourSequenceInterface::DcmDRTContourSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 119 of file mlDcmDRTContourSequenceInterface.h.

~DcmDRTContourSequenceInterface()

virtual ml::DcmDRTContourSequenceInterface::~DcmDRTContourSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 127 of file mlDcmDRTContourSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTContourSequenceInterface::Item & ml::DcmDRTContourSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 211 of file mlDcmDRTContourSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 216 of file mlDcmDRTContourSequenceInterface.h.

getAttachedContours() [1/2]

bool ml::DcmDRTContourSequenceInterface::getAttachedContours	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getAttachedContours() [2/2]

bool ml::DcmDRTContourSequenceInterface::getAttachedContours	(	unsigned long	idx,
		std::string &	parameter
	)		const

getAttachedContoursTag()

std::string ml::DcmDRTContourSequenceInterface::getAttachedContoursTag ( ) const

inline

Definition at line 131 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getAttachedContoursTag().

getContourData() [1/2]

bool ml::DcmDRTContourSequenceInterface::getContourData	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getContourData() [2/2]

bool ml::DcmDRTContourSequenceInterface::getContourData	(	unsigned long	idx,
		std::string &	parameter
	)		const

getContourDataTag()

std::string ml::DcmDRTContourSequenceInterface::getContourDataTag ( ) const

inline

Definition at line 137 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getContourDataTag().

getContourGeometricType() [1/2]

bool ml::DcmDRTContourSequenceInterface::getContourGeometricType	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getContourGeometricType() [2/2]

bool ml::DcmDRTContourSequenceInterface::getContourGeometricType	(	unsigned long	idx,
		std::string &	parameter
	)		const

getContourGeometricTypeTag()

std::string ml::DcmDRTContourSequenceInterface::getContourGeometricTypeTag ( ) const

inline

Definition at line 143 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getContourGeometricTypeTag().

getContourImageSequence()

DcmDRTContourImageSequenceInterface ml::DcmDRTContourSequenceInterface::getContourImageSequence

(

unsigned long

idx

)

const

getContourImageSequenceTag()

std::string ml::DcmDRTContourSequenceInterface::getContourImageSequenceTag ( ) const

inline

Definition at line 172 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getContourImageSequenceTag().

getContourNumber() [1/2]

bool ml::DcmDRTContourSequenceInterface::getContourNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getContourNumber() [2/2]

bool ml::DcmDRTContourSequenceInterface::getContourNumber	(	unsigned long	idx,
		std::string &	parameter
	)		const

getContourNumberTag()

std::string ml::DcmDRTContourSequenceInterface::getContourNumberTag ( ) const

inline

Definition at line 149 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getContourNumberTag().

getContourOffsetVector() [1/2]

bool ml::DcmDRTContourSequenceInterface::getContourOffsetVector	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getContourOffsetVector() [2/2]

bool ml::DcmDRTContourSequenceInterface::getContourOffsetVector	(	unsigned long	idx,
		std::string &	parameter
	)		const

getContourOffsetVectorTag()

std::string ml::DcmDRTContourSequenceInterface::getContourOffsetVectorTag ( ) const

inline

Definition at line 155 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getContourOffsetVectorTag().

getContourSlabThickness() [1/2]

bool ml::DcmDRTContourSequenceInterface::getContourSlabThickness	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getContourSlabThickness() [2/2]

bool ml::DcmDRTContourSequenceInterface::getContourSlabThickness	(	unsigned long	idx,
		std::string &	parameter
	)		const

getContourSlabThicknessTag()

std::string ml::DcmDRTContourSequenceInterface::getContourSlabThicknessTag ( ) const

inline

Definition at line 161 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getContourSlabThicknessTag().

getItem()

DcmDRTContourSequenceInterface::Item ml::DcmDRTContourSequenceInterface::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 202 of file mlDcmDRTContourSequenceInterface.h.

getNumberOfContourPoints() [1/2]

bool ml::DcmDRTContourSequenceInterface::getNumberOfContourPoints	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getNumberOfContourPoints() [2/2]

bool ml::DcmDRTContourSequenceInterface::getNumberOfContourPoints	(	unsigned long	idx,
		std::string &	parameter
	)		const

getNumberOfContourPointsTag()

std::string ml::DcmDRTContourSequenceInterface::getNumberOfContourPointsTag ( ) const

inline

Definition at line 167 of file mlDcmDRTContourSequenceInterface.h.

Referenced by DRTContourSequenceWrapper::getNumberOfContourPointsTag().

getNumberOfItems()

MLint ml::DcmDRTContourSequenceInterface::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 196 of file mlDcmDRTContourSequenceInterface.h.

getSequence()

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

inline

Return the DRTContourSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTContourSequence

Definition at line 184 of file mlDcmDRTContourSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTContourSequenceInterface::hasSequence ( ) const

inline

Check if the DRTContourSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 190 of file mlDcmDRTContourSequenceInterface.h.

insertItem()

bool ml::DcmDRTContourSequenceInterface::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 222 of file mlDcmDRTContourSequenceInterface.h.

removeItem()

bool ml::DcmDRTContourSequenceInterface::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 234 of file mlDcmDRTContourSequenceInterface.h.

setAttachedContours()

bool ml::DcmDRTContourSequenceInterface::setAttachedContours	(	unsigned long	idx,
		std::string	parameter
	)

setContourData()

bool ml::DcmDRTContourSequenceInterface::setContourData	(	unsigned long	idx,
		std::string	parameter
	)

setContourGeometricType()

bool ml::DcmDRTContourSequenceInterface::setContourGeometricType	(	unsigned long	idx,
		std::string	parameter
	)

setContourImageSequence()

void ml::DcmDRTContourSequenceInterface::setContourImageSequence	(	DcmDRTContourImageSequenceInterface	seq,
		unsigned long	idx
	)

setContourNumber()

bool ml::DcmDRTContourSequenceInterface::setContourNumber	(	unsigned long	idx,
		std::string	parameter
	)

setContourOffsetVector()

bool ml::DcmDRTContourSequenceInterface::setContourOffsetVector	(	unsigned long	idx,
		std::string	parameter
	)

setContourSlabThickness()

bool ml::DcmDRTContourSequenceInterface::setContourSlabThickness	(	unsigned long	idx,
		std::string	parameter
	)

setNumberOfContourPoints()

bool ml::DcmDRTContourSequenceInterface::setNumberOfContourPoints	(	unsigned long	idx,
		std::string	parameter
	)

setSequence()

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

inline

Set the DRTContourSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTContourSequence

Definition at line 178 of file mlDcmDRTContourSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 246 of file mlDcmDRTContourSequenceInterface.h.

---

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

• FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTContourSequenceInterface.h