Class to provide access to DRTWedgeSequence. More...

#include <mlDcmDRTWedgeSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTWedgeSequenceInterface ()

	DcmDRTWedgeSequenceInterface (std::vector< DcmDRTWedgeSequenceInterface::Item > dcmSequence)
	Default Constructor.

	DcmDRTWedgeSequenceInterface (DCMTree::TreePtrVector treePtrSeq)

virtual	~DcmDRTWedgeSequenceInterface ()
	Default virtual Destructor.

bool	getAccessoryCode (unsigned long idx, std::string &parameter) const

bool	getAccessoryCode (DCMTree::TreePtr item, std::string &parameter) const

std::string	getAccessoryCodeTag () const

bool	setAccessoryCode (unsigned long idx, std::string parameter)

bool	getSourceToWedgeTrayDistance (unsigned long idx, std::string &parameter) const

bool	getSourceToWedgeTrayDistance (DCMTree::TreePtr item, std::string &parameter) const

std::string	getSourceToWedgeTrayDistanceTag () const

bool	setSourceToWedgeTrayDistance (unsigned long idx, std::string parameter)

bool	getWedgeAngle (unsigned long idx, std::string &parameter) const

bool	getWedgeAngle (DCMTree::TreePtr item, std::string &parameter) const

std::string	getWedgeAngleTag () const

bool	setWedgeAngle (unsigned long idx, std::string parameter)

bool	getWedgeFactor (unsigned long idx, std::string &parameter) const

bool	getWedgeFactor (DCMTree::TreePtr item, std::string &parameter) const

std::string	getWedgeFactorTag () const

bool	setWedgeFactor (unsigned long idx, std::string parameter)

bool	getWedgeID (unsigned long idx, std::string &parameter) const

bool	getWedgeID (DCMTree::TreePtr item, std::string &parameter) const

std::string	getWedgeIDTag () const

bool	setWedgeID (unsigned long idx, std::string parameter)

bool	getWedgeNumber (unsigned long idx, std::string &parameter) const

bool	getWedgeNumber (DCMTree::TreePtr item, std::string &parameter) const

std::string	getWedgeNumberTag () const

bool	setWedgeNumber (unsigned long idx, std::string parameter)

bool	getWedgeOrientation (unsigned long idx, std::string &parameter) const

bool	getWedgeOrientation (DCMTree::TreePtr item, std::string &parameter) const

std::string	getWedgeOrientationTag () const

bool	setWedgeOrientation (unsigned long idx, std::string parameter)

bool	getWedgeType (unsigned long idx, std::string &parameter) const

bool	getWedgeType (DCMTree::TreePtr item, std::string &parameter) const

std::string	getWedgeTypeTag () const

bool	setWedgeType (unsigned long idx, std::string parameter)

void	setSequence (std::vector< DcmDRTWedgeSequenceInterface::Item > dcmSequence)
	Set the DRTWedgeSequence this interface class provides access to.

std::vector< DcmDRTWedgeSequenceInterface::Item >	getSequence () const
	Return the DRTWedgeSequence this interface class provides access to.

bool	hasSequence () const
	Check if the DRTWedgeSequence is set.

MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.

DcmDRTWedgeSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.

DcmDRTWedgeSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.

void	addItem (DcmDRTWedgeSequenceInterface::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< DcmDRTWedgeSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTWedgeSequence.

Definition at line 43 of file mlDcmDRTWedgeSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTWedgeSequenceInterface() [1/3]

ml::DcmDRTWedgeSequenceInterface::DcmDRTWedgeSequenceInterface ( )

inline

Definition at line 113 of file mlDcmDRTWedgeSequenceInterface.h.

◆ DcmDRTWedgeSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 116 of file mlDcmDRTWedgeSequenceInterface.h.

◆ DcmDRTWedgeSequenceInterface() [3/3]

ml::DcmDRTWedgeSequenceInterface::DcmDRTWedgeSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 118 of file mlDcmDRTWedgeSequenceInterface.h.

References mlrange_cast().

◆ ~DcmDRTWedgeSequenceInterface()

virtual ml::DcmDRTWedgeSequenceInterface::~DcmDRTWedgeSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 126 of file mlDcmDRTWedgeSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTWedgeSequenceInterface::Item & ml::DcmDRTWedgeSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns: Return the new item which has been added to the sequence

Definition at line 211 of file mlDcmDRTWedgeSequenceInterface.h.

◆ addItem() [2/2]

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

inline

Definition at line 216 of file mlDcmDRTWedgeSequenceInterface.h.

References mlrange_cast().

◆ getAccessoryCode() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getAccessoryCode	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getAccessoryCode() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getAccessoryCode	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getAccessoryCodeTag()

std::string ml::DcmDRTWedgeSequenceInterface::getAccessoryCodeTag ( ) const

inline

Definition at line 130 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getAccessoryCodeTag().

◆ getItem()

DcmDRTWedgeSequenceInterface::Item ml::DcmDRTWedgeSequenceInterface::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 202 of file mlDcmDRTWedgeSequenceInterface.h.

References mlrange_cast().

◆ getNumberOfItems()

MLint ml::DcmDRTWedgeSequenceInterface::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 196 of file mlDcmDRTWedgeSequenceInterface.h.

◆ getSequence()

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

inline

Return the DRTWedgeSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTWedgeSequence

Definition at line 184 of file mlDcmDRTWedgeSequenceInterface.h.

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

◆ getSourceToWedgeTrayDistance() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getSourceToWedgeTrayDistance	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getSourceToWedgeTrayDistance() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getSourceToWedgeTrayDistance	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getSourceToWedgeTrayDistanceTag()

std::string ml::DcmDRTWedgeSequenceInterface::getSourceToWedgeTrayDistanceTag ( ) const

inline

Definition at line 136 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getSourceToWedgeTrayDistanceTag().

◆ getWedgeAngle() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeAngle	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getWedgeAngle() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeAngle	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getWedgeAngleTag()

std::string ml::DcmDRTWedgeSequenceInterface::getWedgeAngleTag ( ) const

inline

Definition at line 142 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getWedgeAngleTag().

◆ getWedgeFactor() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeFactor	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getWedgeFactor() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeFactor	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getWedgeFactorTag()

std::string ml::DcmDRTWedgeSequenceInterface::getWedgeFactorTag ( ) const

inline

Definition at line 148 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getWedgeFactorTag().

◆ getWedgeID() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getWedgeID() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeID	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getWedgeIDTag()

std::string ml::DcmDRTWedgeSequenceInterface::getWedgeIDTag ( ) const

inline

Definition at line 154 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getWedgeIDTag().

◆ getWedgeNumber() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getWedgeNumber() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeNumber	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getWedgeNumberTag()

std::string ml::DcmDRTWedgeSequenceInterface::getWedgeNumberTag ( ) const

inline

Definition at line 160 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getWedgeNumberTag().

◆ getWedgeOrientation() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeOrientation	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getWedgeOrientation() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeOrientation	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getWedgeOrientationTag()

std::string ml::DcmDRTWedgeSequenceInterface::getWedgeOrientationTag ( ) const

inline

Definition at line 166 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getWedgeOrientationTag().

◆ getWedgeType() [1/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getWedgeType() [2/2]

bool ml::DcmDRTWedgeSequenceInterface::getWedgeType	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getWedgeTypeTag()

std::string ml::DcmDRTWedgeSequenceInterface::getWedgeTypeTag ( ) const

inline

Definition at line 172 of file mlDcmDRTWedgeSequenceInterface.h.

Referenced by DRTWedgeSequenceWrapper::getWedgeTypeTag().

◆ hasSequence()

bool ml::DcmDRTWedgeSequenceInterface::hasSequence ( ) const

inline

Check if the DRTWedgeSequence is set.

Returns: True if internal pointer is set, False else.

Definition at line 190 of file mlDcmDRTWedgeSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTWedgeSequenceInterface::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 222 of file mlDcmDRTWedgeSequenceInterface.h.

References mlrange_cast().

◆ removeItem()

bool ml::DcmDRTWedgeSequenceInterface::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 234 of file mlDcmDRTWedgeSequenceInterface.h.

References mlrange_cast().

◆ setAccessoryCode()

bool ml::DcmDRTWedgeSequenceInterface::setAccessoryCode	(	unsigned long	idx,
		std::string	parameter )

◆ setSequence()

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

inline

Set the DRTWedgeSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTWedgeSequence

Definition at line 178 of file mlDcmDRTWedgeSequenceInterface.h.

References mlrange_cast().

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

◆ setSourceToWedgeTrayDistance()

bool ml::DcmDRTWedgeSequenceInterface::setSourceToWedgeTrayDistance	(	unsigned long	idx,
		std::string	parameter )

◆ setWedgeAngle()

bool ml::DcmDRTWedgeSequenceInterface::setWedgeAngle	(	unsigned long	idx,
		std::string	parameter )

◆ setWedgeFactor()

bool ml::DcmDRTWedgeSequenceInterface::setWedgeFactor	(	unsigned long	idx,
		std::string	parameter )

◆ setWedgeID()

bool ml::DcmDRTWedgeSequenceInterface::setWedgeID	(	unsigned long	idx,
		std::string	parameter )

◆ setWedgeNumber()

bool ml::DcmDRTWedgeSequenceInterface::setWedgeNumber	(	unsigned long	idx,
		std::string	parameter )

◆ setWedgeOrientation()

bool ml::DcmDRTWedgeSequenceInterface::setWedgeOrientation	(	unsigned long	idx,
		std::string	parameter )

◆ setWedgeType()

bool ml::DcmDRTWedgeSequenceInterface::setWedgeType	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

◆ _itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 246 of file mlDcmDRTWedgeSequenceInterface.h.

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

FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTWedgeSequenceInterface.h

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTWedgeSequenceInterface() [1/3]

◆ DcmDRTWedgeSequenceInterface() [2/3]

◆ DcmDRTWedgeSequenceInterface() [3/3]

◆ ~DcmDRTWedgeSequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getAccessoryCode() [1/2]

◆ getAccessoryCode() [2/2]

◆ getAccessoryCodeTag()

◆ getItem()

◆ getNumberOfItems()

◆ getSequence()

◆ getSourceToWedgeTrayDistance() [1/2]

◆ getSourceToWedgeTrayDistance() [2/2]

◆ getSourceToWedgeTrayDistanceTag()

◆ getWedgeAngle() [1/2]

◆ getWedgeAngle() [2/2]

◆ getWedgeAngleTag()

◆ getWedgeFactor() [1/2]

◆ getWedgeFactor() [2/2]

◆ getWedgeFactorTag()

◆ getWedgeID() [1/2]

◆ getWedgeID() [2/2]

◆ getWedgeIDTag()

◆ getWedgeNumber() [1/2]

◆ getWedgeNumber() [2/2]

◆ getWedgeNumberTag()

◆ getWedgeOrientation() [1/2]

◆ getWedgeOrientation() [2/2]

◆ getWedgeOrientationTag()

◆ getWedgeType() [1/2]

◆ getWedgeType() [2/2]

◆ getWedgeTypeTag()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setAccessoryCode()

◆ setSequence()

◆ setSourceToWedgeTrayDistance()

◆ setWedgeAngle()

◆ setWedgeFactor()

◆ setWedgeID()

◆ setWedgeNumber()

◆ setWedgeOrientation()

◆ setWedgeType()

Member Data Documentation

◆ _itemVec