ml::DcmDRTIonWedgePositionSequenceInterface Class Reference

Class to provide access to DRTIonWedgePositionSequence. More...

#include <mlDcmDRTIonWedgePositionSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTIonWedgePositionSequenceInterface ()
	DcmDRTIonWedgePositionSequenceInterface (std::vector< DcmDRTIonWedgePositionSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTIonWedgePositionSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTIonWedgePositionSequenceInterface ()
	Default virtual Destructor.
bool	getReferencedWedgeNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedWedgeNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedWedgeNumberTag () const
bool	setReferencedWedgeNumber (unsigned long idx, std::string parameter)
bool	getWedgePosition (unsigned long idx, std::string &parameter) const
bool	getWedgePosition (DCMTree::TreePtr item, std::string &parameter) const
std::string	getWedgePositionTag () const
bool	setWedgePosition (unsigned long idx, std::string parameter)
bool	getWedgeThinEdgePosition (unsigned long idx, float &parameter) const
bool	getWedgeThinEdgePosition (DCMTree::TreePtr item, float &parameter) const
std::string	getWedgeThinEdgePositionTag () const
bool	setWedgeThinEdgePosition (unsigned long idx, float parameter)
void	setSequence (std::vector< DcmDRTIonWedgePositionSequenceInterface::Item > dcmSequence)
	Set the DRTIonWedgePositionSequence this interface class provides access to.
std::vector< DcmDRTIonWedgePositionSequenceInterface::Item >	getSequence () const
	Return the DRTIonWedgePositionSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTIonWedgePositionSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTIonWedgePositionSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTIonWedgePositionSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTIonWedgePositionSequenceInterface::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< DcmDRTIonWedgePositionSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTIonWedgePositionSequence.

Definition at line 43 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTIonWedgePositionSequenceInterface() [1/3]

ml::DcmDRTIonWedgePositionSequenceInterface::DcmDRTIonWedgePositionSequenceInterface ( )

inline

Definition at line 88 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

DcmDRTIonWedgePositionSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 91 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

DcmDRTIonWedgePositionSequenceInterface() [3/3]

ml::DcmDRTIonWedgePositionSequenceInterface::DcmDRTIonWedgePositionSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 93 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

References mlrange_cast().

~DcmDRTIonWedgePositionSequenceInterface()

virtual ml::DcmDRTIonWedgePositionSequenceInterface::~DcmDRTIonWedgePositionSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTIonWedgePositionSequenceInterface::Item & ml::DcmDRTIonWedgePositionSequenceInterface::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 mlDcmDRTIonWedgePositionSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

References mlrange_cast().

getItem()

DcmDRTIonWedgePositionSequenceInterface::Item ml::DcmDRTIonWedgePositionSequenceInterface::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 mlDcmDRTIonWedgePositionSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTIonWedgePositionSequenceInterface::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 mlDcmDRTIonWedgePositionSequenceInterface.h.

getReferencedWedgeNumber() [1/2]

bool ml::DcmDRTIonWedgePositionSequenceInterface::getReferencedWedgeNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getReferencedWedgeNumber() [2/2]

bool ml::DcmDRTIonWedgePositionSequenceInterface::getReferencedWedgeNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getReferencedWedgeNumberTag()

std::string ml::DcmDRTIonWedgePositionSequenceInterface::getReferencedWedgeNumberTag ( ) const

inline

Definition at line 105 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

Referenced by DRTIonWedgePositionSequenceWrapper::getReferencedWedgeNumberTag().

getSequence()

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

inline

Return the DRTIonWedgePositionSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTIonWedgePositionSequence

Definition at line 129 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

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

getWedgePosition() [1/2]

bool ml::DcmDRTIonWedgePositionSequenceInterface::getWedgePosition	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getWedgePosition() [2/2]

bool ml::DcmDRTIonWedgePositionSequenceInterface::getWedgePosition	(	unsigned long	idx,
		std::string &	parameter ) const

getWedgePositionTag()

std::string ml::DcmDRTIonWedgePositionSequenceInterface::getWedgePositionTag ( ) const

inline

Definition at line 111 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

Referenced by DRTIonWedgePositionSequenceWrapper::getWedgePositionTag().

getWedgeThinEdgePosition() [1/2]

bool ml::DcmDRTIonWedgePositionSequenceInterface::getWedgeThinEdgePosition	(	DCMTree::TreePtr	item,
		float &	parameter ) const

getWedgeThinEdgePosition() [2/2]

bool ml::DcmDRTIonWedgePositionSequenceInterface::getWedgeThinEdgePosition	(	unsigned long	idx,
		float &	parameter ) const

getWedgeThinEdgePositionTag()

std::string ml::DcmDRTIonWedgePositionSequenceInterface::getWedgeThinEdgePositionTag ( ) const

inline

Definition at line 117 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

Referenced by DRTIonWedgePositionSequenceWrapper::getWedgeThinEdgePositionTag().

hasSequence()

bool ml::DcmDRTIonWedgePositionSequenceInterface::hasSequence ( ) const

inline

Check if the DRTIonWedgePositionSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

insertItem()

bool ml::DcmDRTIonWedgePositionSequenceInterface::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 mlDcmDRTIonWedgePositionSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTIonWedgePositionSequenceInterface::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 mlDcmDRTIonWedgePositionSequenceInterface.h.

References mlrange_cast().

setReferencedWedgeNumber()

bool ml::DcmDRTIonWedgePositionSequenceInterface::setReferencedWedgeNumber	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTIonWedgePositionSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTIonWedgePositionSequence

Definition at line 123 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

References mlrange_cast().

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

setWedgePosition()

bool ml::DcmDRTIonWedgePositionSequenceInterface::setWedgePosition	(	unsigned long	idx,
		std::string	parameter )

setWedgeThinEdgePosition()

bool ml::DcmDRTIonWedgePositionSequenceInterface::setWedgeThinEdgePosition	(	unsigned long	idx,
		float	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTIonWedgePositionSequenceInterface.h.

---

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

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