ml::DcmDRTMotionSynchronizationSequenceInterface Class Reference

Class to provide access to DRTMotionSynchronizationSequence. More...

#include <mlDcmDRTMotionSynchronizationSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTMotionSynchronizationSequenceInterface ()
	DcmDRTMotionSynchronizationSequenceInterface (std::vector< DcmDRTMotionSynchronizationSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTMotionSynchronizationSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTMotionSynchronizationSequenceInterface ()
	Default virtual Destructor.
bool	getRespiratoryMotionCompensationTechnique (unsigned long idx, std::string &parameter) const
bool	getRespiratoryMotionCompensationTechnique (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRespiratoryMotionCompensationTechniqueTag () const
bool	setRespiratoryMotionCompensationTechnique (unsigned long idx, std::string parameter)
bool	getRespiratoryMotionCompensationTechniqueDescription (unsigned long idx, std::string &parameter) const
bool	getRespiratoryMotionCompensationTechniqueDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRespiratoryMotionCompensationTechniqueDescriptionTag () const
bool	setRespiratoryMotionCompensationTechniqueDescription (unsigned long idx, std::string parameter)
bool	getRespiratorySignalSource (unsigned long idx, std::string &parameter) const
bool	getRespiratorySignalSource (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRespiratorySignalSourceTag () const
bool	setRespiratorySignalSource (unsigned long idx, std::string parameter)
bool	getRespiratorySignalSourceID (unsigned long idx, std::string &parameter) const
bool	getRespiratorySignalSourceID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRespiratorySignalSourceIDTag () const
bool	setRespiratorySignalSourceID (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTMotionSynchronizationSequenceInterface::Item > dcmSequence)
	Set the DRTMotionSynchronizationSequence this interface class provides access to.
std::vector< DcmDRTMotionSynchronizationSequenceInterface::Item >	getSequence () const
	Return the DRTMotionSynchronizationSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTMotionSynchronizationSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTMotionSynchronizationSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTMotionSynchronizationSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTMotionSynchronizationSequenceInterface::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< DcmDRTMotionSynchronizationSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTMotionSynchronizationSequence.

Definition at line 43 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTMotionSynchronizationSequenceInterface() [1/3]

ml::DcmDRTMotionSynchronizationSequenceInterface::DcmDRTMotionSynchronizationSequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

DcmDRTMotionSynchronizationSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

DcmDRTMotionSynchronizationSequenceInterface() [3/3]

ml::DcmDRTMotionSynchronizationSequenceInterface::DcmDRTMotionSynchronizationSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

References mlrange_cast().

~DcmDRTMotionSynchronizationSequenceInterface()

virtual ml::DcmDRTMotionSynchronizationSequenceInterface::~DcmDRTMotionSynchronizationSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTMotionSynchronizationSequenceInterface::Item & ml::DcmDRTMotionSynchronizationSequenceInterface::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 mlDcmDRTMotionSynchronizationSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

References mlrange_cast().

getItem()

DcmDRTMotionSynchronizationSequenceInterface::Item ml::DcmDRTMotionSynchronizationSequenceInterface::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 mlDcmDRTMotionSynchronizationSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTMotionSynchronizationSequenceInterface::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 mlDcmDRTMotionSynchronizationSequenceInterface.h.

getRespiratoryMotionCompensationTechnique() [1/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechnique	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRespiratoryMotionCompensationTechnique() [2/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechnique	(	unsigned long	idx,
		std::string &	parameter ) const

getRespiratoryMotionCompensationTechniqueDescription() [1/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueDescription	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRespiratoryMotionCompensationTechniqueDescription() [2/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueDescription	(	unsigned long	idx,
		std::string &	parameter ) const

getRespiratoryMotionCompensationTechniqueDescriptionTag()

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueDescriptionTag ( ) const

inline

Definition at line 116 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

Referenced by DRTMotionSynchronizationSequenceWrapper::getRespiratoryMotionCompensationTechniqueDescriptionTag().

getRespiratoryMotionCompensationTechniqueTag()

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratoryMotionCompensationTechniqueTag ( ) const

inline

Definition at line 110 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

Referenced by DRTMotionSynchronizationSequenceWrapper::getRespiratoryMotionCompensationTechniqueTag().

getRespiratorySignalSource() [1/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSource	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRespiratorySignalSource() [2/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSource	(	unsigned long	idx,
		std::string &	parameter ) const

getRespiratorySignalSourceID() [1/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRespiratorySignalSourceID() [2/2]

bool ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceID	(	unsigned long	idx,
		std::string &	parameter ) const

getRespiratorySignalSourceIDTag()

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceIDTag ( ) const

inline

Definition at line 128 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

Referenced by DRTMotionSynchronizationSequenceWrapper::getRespiratorySignalSourceIDTag().

getRespiratorySignalSourceTag()

std::string ml::DcmDRTMotionSynchronizationSequenceInterface::getRespiratorySignalSourceTag ( ) const

inline

Definition at line 122 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

Referenced by DRTMotionSynchronizationSequenceWrapper::getRespiratorySignalSourceTag().

getSequence()

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

inline

Return the DRTMotionSynchronizationSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMotionSynchronizationSequence

Definition at line 140 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTMotionSynchronizationSequenceInterface::hasSequence ( ) const

inline

Check if the DRTMotionSynchronizationSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

insertItem()

bool ml::DcmDRTMotionSynchronizationSequenceInterface::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 mlDcmDRTMotionSynchronizationSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTMotionSynchronizationSequenceInterface::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 mlDcmDRTMotionSynchronizationSequenceInterface.h.

References mlrange_cast().

setRespiratoryMotionCompensationTechnique()

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratoryMotionCompensationTechnique	(	unsigned long	idx,
		std::string	parameter )

setRespiratoryMotionCompensationTechniqueDescription()

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratoryMotionCompensationTechniqueDescription	(	unsigned long	idx,
		std::string	parameter )

setRespiratorySignalSource()

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratorySignalSource	(	unsigned long	idx,
		std::string	parameter )

setRespiratorySignalSourceID()

bool ml::DcmDRTMotionSynchronizationSequenceInterface::setRespiratorySignalSourceID	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTMotionSynchronizationSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMotionSynchronizationSequence

Definition at line 134 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTMotionSynchronizationSequenceInterface.h.

---

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

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