Class to provide access to DRTIonWedgeSequence. More...

#include <mlDcmDRTIonWedgeSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTIonWedgeSequenceInterface ()

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

	DcmDRTIonWedgeSequenceInterface (DCMTree::TreePtrVector treePtrSeq)

virtual	~DcmDRTIonWedgeSequenceInterface ()
	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	getIsocenterToWedgeTrayDistance (unsigned long idx, float &parameter) const

bool	getIsocenterToWedgeTrayDistance (DCMTree::TreePtr item, float &parameter) const

std::string	getIsocenterToWedgeTrayDistanceTag () const

bool	setIsocenterToWedgeTrayDistance (unsigned long idx, float 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	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< DcmDRTIonWedgeSequenceInterface::Item > dcmSequence)
	Set the DRTIonWedgeSequence this interface class provides access to.

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

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

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

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

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

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

Detailed Description

Class to provide access to DRTIonWedgeSequence.

Definition at line 43 of file mlDcmDRTIonWedgeSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTIonWedgeSequenceInterface() [1/3]

ml::DcmDRTIonWedgeSequenceInterface::DcmDRTIonWedgeSequenceInterface ( )

inline

Definition at line 108 of file mlDcmDRTIonWedgeSequenceInterface.h.

◆ DcmDRTIonWedgeSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 111 of file mlDcmDRTIonWedgeSequenceInterface.h.

◆ DcmDRTIonWedgeSequenceInterface() [3/3]

ml::DcmDRTIonWedgeSequenceInterface::DcmDRTIonWedgeSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 113 of file mlDcmDRTIonWedgeSequenceInterface.h.

References mlrange_cast().

◆ ~DcmDRTIonWedgeSequenceInterface()

virtual ml::DcmDRTIonWedgeSequenceInterface::~DcmDRTIonWedgeSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTIonWedgeSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTIonWedgeSequenceInterface::Item & ml::DcmDRTIonWedgeSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

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

Definition at line 200 of file mlDcmDRTIonWedgeSequenceInterface.h.

◆ addItem() [2/2]

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

inline

Definition at line 205 of file mlDcmDRTIonWedgeSequenceInterface.h.

References mlrange_cast().

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

inline

Definition at line 125 of file mlDcmDRTIonWedgeSequenceInterface.h.

Referenced by DRTIonWedgeSequenceWrapper::getAccessoryCodeTag().

◆ getIsocenterToWedgeTrayDistance() [1/2]

bool ml::DcmDRTIonWedgeSequenceInterface::getIsocenterToWedgeTrayDistance	(	DCMTree::TreePtr	item,
		float &	parameter ) const

◆ getIsocenterToWedgeTrayDistance() [2/2]

bool ml::DcmDRTIonWedgeSequenceInterface::getIsocenterToWedgeTrayDistance	(	unsigned long	idx,
		float &	parameter ) const

◆ getIsocenterToWedgeTrayDistanceTag()

std::string ml::DcmDRTIonWedgeSequenceInterface::getIsocenterToWedgeTrayDistanceTag ( ) const

inline

Definition at line 131 of file mlDcmDRTIonWedgeSequenceInterface.h.

Referenced by DRTIonWedgeSequenceWrapper::getIsocenterToWedgeTrayDistanceTag().

◆ getItem()

DcmDRTIonWedgeSequenceInterface::Item ml::DcmDRTIonWedgeSequenceInterface::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 191 of file mlDcmDRTIonWedgeSequenceInterface.h.

References mlrange_cast().

◆ getNumberOfItems()

MLint ml::DcmDRTIonWedgeSequenceInterface::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 185 of file mlDcmDRTIonWedgeSequenceInterface.h.

◆ getSequence()

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

inline

Return the DRTIonWedgeSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTIonWedgeSequence

Definition at line 173 of file mlDcmDRTIonWedgeSequenceInterface.h.

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

◆ getWedgeAngle() [1/2]

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

◆ getWedgeAngle() [2/2]

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

◆ getWedgeAngleTag()

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

inline

Definition at line 137 of file mlDcmDRTIonWedgeSequenceInterface.h.

Referenced by DRTIonWedgeSequenceWrapper::getWedgeAngleTag().

◆ getWedgeID() [1/2]

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

◆ getWedgeID() [2/2]

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

◆ getWedgeIDTag()

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

inline

Definition at line 143 of file mlDcmDRTIonWedgeSequenceInterface.h.

Referenced by DRTIonWedgeSequenceWrapper::getWedgeIDTag().

◆ getWedgeNumber() [1/2]

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

◆ getWedgeNumber() [2/2]

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

◆ getWedgeNumberTag()

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

inline

Definition at line 149 of file mlDcmDRTIonWedgeSequenceInterface.h.

Referenced by DRTIonWedgeSequenceWrapper::getWedgeNumberTag().

◆ getWedgeOrientation() [1/2]

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

◆ getWedgeOrientation() [2/2]

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

◆ getWedgeOrientationTag()

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

inline

Definition at line 155 of file mlDcmDRTIonWedgeSequenceInterface.h.

Referenced by DRTIonWedgeSequenceWrapper::getWedgeOrientationTag().

◆ getWedgeType() [1/2]

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

◆ getWedgeType() [2/2]

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

◆ getWedgeTypeTag()

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

inline

Definition at line 161 of file mlDcmDRTIonWedgeSequenceInterface.h.

Referenced by DRTIonWedgeSequenceWrapper::getWedgeTypeTag().

◆ hasSequence()

bool ml::DcmDRTIonWedgeSequenceInterface::hasSequence ( ) const

inline

Check if the DRTIonWedgeSequence is set.

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

Definition at line 179 of file mlDcmDRTIonWedgeSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTIonWedgeSequenceInterface::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 211 of file mlDcmDRTIonWedgeSequenceInterface.h.

References mlrange_cast().

◆ removeItem()

bool ml::DcmDRTIonWedgeSequenceInterface::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 223 of file mlDcmDRTIonWedgeSequenceInterface.h.

References mlrange_cast().

◆ setAccessoryCode()

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

◆ setIsocenterToWedgeTrayDistance()

bool ml::DcmDRTIonWedgeSequenceInterface::setIsocenterToWedgeTrayDistance	(	unsigned long	idx,
		float	parameter )

◆ setSequence()

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

inline

Set the DRTIonWedgeSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTIonWedgeSequence

Definition at line 167 of file mlDcmDRTIonWedgeSequenceInterface.h.

References mlrange_cast().

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

◆ setWedgeAngle()

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

◆ setWedgeID()

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

◆ setWedgeNumber()

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

◆ setWedgeOrientation()

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

◆ setWedgeType()

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

Member Data Documentation

◆ _itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTIonWedgeSequenceInterface.h.

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

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

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTIonWedgeSequenceInterface() [1/3]

◆ DcmDRTIonWedgeSequenceInterface() [2/3]

◆ DcmDRTIonWedgeSequenceInterface() [3/3]

◆ ~DcmDRTIonWedgeSequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getAccessoryCode() [1/2]

◆ getAccessoryCode() [2/2]

◆ getAccessoryCodeTag()

◆ getIsocenterToWedgeTrayDistance() [1/2]

◆ getIsocenterToWedgeTrayDistance() [2/2]

◆ getIsocenterToWedgeTrayDistanceTag()

◆ getItem()

◆ getNumberOfItems()

◆ getSequence()

◆ getWedgeAngle() [1/2]

◆ getWedgeAngle() [2/2]

◆ getWedgeAngleTag()

◆ 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()

◆ setIsocenterToWedgeTrayDistance()

◆ setSequence()

◆ setWedgeAngle()

◆ setWedgeID()

◆ setWedgeNumber()

◆ setWedgeOrientation()

◆ setWedgeType()

Member Data Documentation

◆ _itemVec