ml::DcmDRTRTReferencedSeriesSequenceInterface Class Reference

Class to provide access to DRTRTReferencedSeriesSequence. More...

#include <mlDcmDRTRTReferencedSeriesSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRTReferencedSeriesSequenceInterface ()
	DcmDRTRTReferencedSeriesSequenceInterface (std::vector< DcmDRTRTReferencedSeriesSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRTReferencedSeriesSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRTReferencedSeriesSequenceInterface ()
	Default virtual Destructor.
bool	getSeriesInstanceUID (unsigned long idx, std::string &parameter) const
bool	getSeriesInstanceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getSeriesInstanceUIDTag () const
bool	setSeriesInstanceUID (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< DcmDRTRTReferencedSeriesSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTRTReferencedSeriesSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTRTReferencedSeriesSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTRTReferencedSeriesSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTRTReferencedSeriesSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTRTReferencedSeriesSequence.

Definition at line 44 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTRTReferencedSeriesSequenceInterface() [1/3]

ml::DcmDRTRTReferencedSeriesSequenceInterface::DcmDRTRTReferencedSeriesSequenceInterface ( )

inline

Definition at line 84 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

DcmDRTRTReferencedSeriesSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 87 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

DcmDRTRTReferencedSeriesSequenceInterface() [3/3]

ml::DcmDRTRTReferencedSeriesSequenceInterface::DcmDRTRTReferencedSeriesSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 89 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

~DcmDRTRTReferencedSeriesSequenceInterface()

virtual ml::DcmDRTRTReferencedSeriesSequenceInterface::~DcmDRTRTReferencedSeriesSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 97 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTRTReferencedSeriesSequenceInterface::Item & ml::DcmDRTRTReferencedSeriesSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 145 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 150 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

getContourImageSequence()

DcmDRTContourImageSequenceInterface ml::DcmDRTRTReferencedSeriesSequenceInterface::getContourImageSequence

(

unsigned long

idx

)

const

getContourImageSequenceTag()

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

inline

Definition at line 106 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

getItem()

DcmDRTRTReferencedSeriesSequenceInterface::Item ml::DcmDRTRTReferencedSeriesSequenceInterface::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 136 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTRTReferencedSeriesSequenceInterface::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 130 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

getSequence()

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

inline

Return the DRTRTReferencedSeriesSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTReferencedSeriesSequence

Definition at line 118 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

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

getSeriesInstanceUID() [1/2]

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::getSeriesInstanceUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getSeriesInstanceUID() [2/2]

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::getSeriesInstanceUID	(	unsigned long	idx,
		std::string &	parameter ) const

getSeriesInstanceUIDTag()

std::string ml::DcmDRTRTReferencedSeriesSequenceInterface::getSeriesInstanceUIDTag ( ) const

inline

Definition at line 101 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

hasSequence()

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::hasSequence ( ) const

inline

Check if the DRTRTReferencedSeriesSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::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 156 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

removeItem()

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

References _itemVec.

setContourImageSequence()

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

setSequence()

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

inline

Set the DRTRTReferencedSeriesSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTRTReferencedSeriesSequence

Definition at line 112 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

References _itemVec.

setSeriesInstanceUID()

bool ml::DcmDRTRTReferencedSeriesSequenceInterface::setSeriesInstanceUID	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTRTReferencedSeriesSequenceInterface.h.

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