ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface Class Reference

Class to provide access to DRTFrameOfReferenceRelationshipSequence. More...

#include <mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTFrameOfReferenceRelationshipSequenceInterface ()
	DcmDRTFrameOfReferenceRelationshipSequenceInterface (std::vector< DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTFrameOfReferenceRelationshipSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTFrameOfReferenceRelationshipSequenceInterface ()
	Default virtual Destructor.
bool	getFrameOfReferenceTransformationComment (unsigned long idx, std::string &parameter) const
bool	getFrameOfReferenceTransformationComment (DCMTree::TreePtr item, std::string &parameter) const
std::string	getFrameOfReferenceTransformationCommentTag () const
bool	setFrameOfReferenceTransformationComment (unsigned long idx, std::string parameter)
bool	getFrameOfReferenceTransformationMatrix (unsigned long idx, std::string &parameter) const
bool	getFrameOfReferenceTransformationMatrix (DCMTree::TreePtr item, std::string &parameter) const
std::string	getFrameOfReferenceTransformationMatrixTag () const
bool	setFrameOfReferenceTransformationMatrix (unsigned long idx, std::string parameter)
bool	getFrameOfReferenceTransformationType (unsigned long idx, std::string &parameter) const
bool	getFrameOfReferenceTransformationType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getFrameOfReferenceTransformationTypeTag () const
bool	setFrameOfReferenceTransformationType (unsigned long idx, std::string parameter)
bool	getRelatedFrameOfReferenceUID (unsigned long idx, std::string &parameter) const
bool	getRelatedFrameOfReferenceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getRelatedFrameOfReferenceUIDTag () const
bool	setRelatedFrameOfReferenceUID (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTFrameOfReferenceRelationshipSequence.

Definition at line 43 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTFrameOfReferenceRelationshipSequenceInterface() [1/3]

ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::DcmDRTFrameOfReferenceRelationshipSequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

DcmDRTFrameOfReferenceRelationshipSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

DcmDRTFrameOfReferenceRelationshipSequenceInterface() [3/3]

ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::DcmDRTFrameOfReferenceRelationshipSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

~DcmDRTFrameOfReferenceRelationshipSequenceInterface()

virtual ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::~DcmDRTFrameOfReferenceRelationshipSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item & ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::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 mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 172 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

getFrameOfReferenceTransformationComment() [1/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationComment	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getFrameOfReferenceTransformationComment() [2/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationComment	(	unsigned long	idx,
		std::string &	parameter ) const

getFrameOfReferenceTransformationCommentTag()

std::string ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationCommentTag ( ) const

inline

Definition at line 110 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

getFrameOfReferenceTransformationMatrix() [1/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationMatrix	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getFrameOfReferenceTransformationMatrix() [2/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationMatrix	(	unsigned long	idx,
		std::string &	parameter ) const

getFrameOfReferenceTransformationMatrixTag()

std::string ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationMatrixTag ( ) const

inline

Definition at line 116 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

getFrameOfReferenceTransformationType() [1/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getFrameOfReferenceTransformationType() [2/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationType	(	unsigned long	idx,
		std::string &	parameter ) const

getFrameOfReferenceTransformationTypeTag()

std::string ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getFrameOfReferenceTransformationTypeTag ( ) const

inline

Definition at line 122 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

getItem()

DcmDRTFrameOfReferenceRelationshipSequenceInterface::Item ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::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 mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::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 mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

getRelatedFrameOfReferenceUID() [1/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getRelatedFrameOfReferenceUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getRelatedFrameOfReferenceUID() [2/2]

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getRelatedFrameOfReferenceUID	(	unsigned long	idx,
		std::string &	parameter ) const

getRelatedFrameOfReferenceUIDTag()

std::string ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::getRelatedFrameOfReferenceUIDTag ( ) const

inline

Definition at line 128 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

getSequence()

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

inline

Return the DRTFrameOfReferenceRelationshipSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTFrameOfReferenceRelationshipSequence

Definition at line 140 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::hasSequence ( ) const

inline

Check if the DRTFrameOfReferenceRelationshipSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::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 mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::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 mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

setFrameOfReferenceTransformationComment()

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::setFrameOfReferenceTransformationComment	(	unsigned long	idx,
		std::string	parameter )

setFrameOfReferenceTransformationMatrix()

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::setFrameOfReferenceTransformationMatrix	(	unsigned long	idx,
		std::string	parameter )

setFrameOfReferenceTransformationType()

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::setFrameOfReferenceTransformationType	(	unsigned long	idx,
		std::string	parameter )

setRelatedFrameOfReferenceUID()

bool ml::DcmDRTFrameOfReferenceRelationshipSequenceInterface::setRelatedFrameOfReferenceUID	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTFrameOfReferenceRelationshipSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTFrameOfReferenceRelationshipSequence

Definition at line 134 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTFrameOfReferenceRelationshipSequenceInterface.h.

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