ml::DcmDRTMACParametersSequenceInterface Class Reference

Class to provide access to DRTMACParametersSequence. More...

#include <mlDcmDRTMACParametersSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTMACParametersSequenceInterface ()
	DcmDRTMACParametersSequenceInterface (std::vector< DcmDRTMACParametersSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTMACParametersSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTMACParametersSequenceInterface ()
	Default virtual Destructor.
bool	getMACAlgorithm (unsigned long idx, std::string &parameter) const
bool	getMACAlgorithm (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMACAlgorithmTag () const
bool	setMACAlgorithm (unsigned long idx, std::string parameter)
bool	getMACCalculationTransferSyntaxUID (unsigned long idx, std::string &parameter) const
bool	getMACCalculationTransferSyntaxUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMACCalculationTransferSyntaxUIDTag () const
bool	setMACCalculationTransferSyntaxUID (unsigned long idx, std::string parameter)
bool	getMACIDNumber (unsigned long idx, MLuint16 &parameter) const
bool	getMACIDNumber (DCMTree::TreePtr item, MLuint16 &parameter) const
std::string	getMACIDNumberTag () const
bool	setMACIDNumber (unsigned long idx, MLuint16 parameter)
void	setSequence (std::vector< DcmDRTMACParametersSequenceInterface::Item > dcmSequence)
	Set the DRTMACParametersSequence this interface class provides access to.
std::vector< DcmDRTMACParametersSequenceInterface::Item >	getSequence () const
	Return the DRTMACParametersSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTMACParametersSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTMACParametersSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTMACParametersSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTMACParametersSequenceInterface::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< DcmDRTMACParametersSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTMACParametersSequence.

Definition at line 43 of file mlDcmDRTMACParametersSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTMACParametersSequenceInterface() [1/3]

ml::DcmDRTMACParametersSequenceInterface::DcmDRTMACParametersSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTMACParametersSequenceInterface.h.

DcmDRTMACParametersSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTMACParametersSequenceInterface.h.

DcmDRTMACParametersSequenceInterface() [3/3]

ml::DcmDRTMACParametersSequenceInterface::DcmDRTMACParametersSequenceInterface ( DCMTree::TreePtrVector  treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTMACParametersSequenceInterface.h.

~DcmDRTMACParametersSequenceInterface()

virtual ml::DcmDRTMACParametersSequenceInterface::~DcmDRTMACParametersSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTMACParametersSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTMACParametersSequenceInterface::Item & ml::DcmDRTMACParametersSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 156 of file mlDcmDRTMACParametersSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTMACParametersSequenceInterface.h.

getItem()

DcmDRTMACParametersSequenceInterface::Item ml::DcmDRTMACParametersSequenceInterface::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 147 of file mlDcmDRTMACParametersSequenceInterface.h.

getMACAlgorithm() [1/2]

bool ml::DcmDRTMACParametersSequenceInterface::getMACAlgorithm	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getMACAlgorithm() [2/2]

bool ml::DcmDRTMACParametersSequenceInterface::getMACAlgorithm	(	unsigned long	idx,
		std::string &	parameter
	)		const

getMACAlgorithmTag()

std::string ml::DcmDRTMACParametersSequenceInterface::getMACAlgorithmTag ( ) const

inline

Definition at line 105 of file mlDcmDRTMACParametersSequenceInterface.h.

Referenced by DRTMACParametersSequenceWrapper::getMACAlgorithmTag().

getMACCalculationTransferSyntaxUID() [1/2]

bool ml::DcmDRTMACParametersSequenceInterface::getMACCalculationTransferSyntaxUID	(	DCMTree::TreePtr	item,
		std::string &	parameter
	)		const

getMACCalculationTransferSyntaxUID() [2/2]

bool ml::DcmDRTMACParametersSequenceInterface::getMACCalculationTransferSyntaxUID	(	unsigned long	idx,
		std::string &	parameter
	)		const

getMACCalculationTransferSyntaxUIDTag()

std::string ml::DcmDRTMACParametersSequenceInterface::getMACCalculationTransferSyntaxUIDTag ( ) const

inline

Definition at line 111 of file mlDcmDRTMACParametersSequenceInterface.h.

Referenced by DRTMACParametersSequenceWrapper::getMACCalculationTransferSyntaxUIDTag().

getMACIDNumber() [1/2]

bool ml::DcmDRTMACParametersSequenceInterface::getMACIDNumber	(	DCMTree::TreePtr	item,
		MLuint16 &	parameter
	)		const

getMACIDNumber() [2/2]

bool ml::DcmDRTMACParametersSequenceInterface::getMACIDNumber	(	unsigned long	idx,
		MLuint16 &	parameter
	)		const

getMACIDNumberTag()

std::string ml::DcmDRTMACParametersSequenceInterface::getMACIDNumberTag ( ) const

inline

Definition at line 117 of file mlDcmDRTMACParametersSequenceInterface.h.

Referenced by DRTMACParametersSequenceWrapper::getMACIDNumberTag().

getNumberOfItems()

MLint ml::DcmDRTMACParametersSequenceInterface::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 141 of file mlDcmDRTMACParametersSequenceInterface.h.

getSequence()

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

inline

Return the DRTMACParametersSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMACParametersSequence

Definition at line 129 of file mlDcmDRTMACParametersSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTMACParametersSequenceInterface::hasSequence ( ) const

inline

Check if the DRTMACParametersSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTMACParametersSequenceInterface.h.

insertItem()

bool ml::DcmDRTMACParametersSequenceInterface::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 167 of file mlDcmDRTMACParametersSequenceInterface.h.

removeItem()

bool ml::DcmDRTMACParametersSequenceInterface::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 179 of file mlDcmDRTMACParametersSequenceInterface.h.

setMACAlgorithm()

bool ml::DcmDRTMACParametersSequenceInterface::setMACAlgorithm	(	unsigned long	idx,
		std::string	parameter
	)

setMACCalculationTransferSyntaxUID()

bool ml::DcmDRTMACParametersSequenceInterface::setMACCalculationTransferSyntaxUID	(	unsigned long	idx,
		std::string	parameter
	)

setMACIDNumber()

bool ml::DcmDRTMACParametersSequenceInterface::setMACIDNumber	(	unsigned long	idx,
		MLuint16	parameter
	)

setSequence()

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

inline

Set the DRTMACParametersSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMACParametersSequence

Definition at line 123 of file mlDcmDRTMACParametersSequenceInterface.h.

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTMACParametersSequenceInterface.h.

---

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

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