MeVisLab Toolbox Reference
ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface Class Reference

Class to provide access to DRTBeamLimitingDeviceLeafPairsSequence. More...

#include <mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface ()
 DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface (std::vector< DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface ()
 Default virtual Destructor.
bool getNumberOfLeafJawPairs (unsigned long idx, std::string &parameter) const
bool getNumberOfLeafJawPairs (DCMTree::TreePtr item, std::string &parameter) const
std::string getNumberOfLeafJawPairsTag () const
bool setNumberOfLeafJawPairs (unsigned long idx, std::string parameter)
bool getRTBeamLimitingDeviceType (unsigned long idx, std::string &parameter) const
bool getRTBeamLimitingDeviceType (DCMTree::TreePtr item, std::string &parameter) const
std::string getRTBeamLimitingDeviceTypeTag () const
bool setRTBeamLimitingDeviceType (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item getItem (const size_t idx) const
DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item & addItem ()
void addItem (DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

std::vector< DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTBeamLimitingDeviceLeafPairsSequence.

Definition at line 43 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface() [1/3]

ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface ( )
inline

Definition at line 83 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

◆ DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface() [2/3]

ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface ( std::vector< DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item > dcmSequence)
inline

Default Constructor.

Definition at line 86 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface() [3/3]

ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface ( DCMTree::TreePtrVector treePtrSeq)
inline

Definition at line 88 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface()

virtual ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::~DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 96 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item & ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::addItem ( )
inline

Adds a new item to the sequence

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

Definition at line 145 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

void ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::addItem ( DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item newItem)
inline

Definition at line 150 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ getItem()

DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::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 136 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::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 130 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ getNumberOfLeafJawPairs() [1/2]

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::getNumberOfLeafJawPairs ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getNumberOfLeafJawPairs() [2/2]

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::getNumberOfLeafJawPairs ( unsigned long idx,
std::string & parameter ) const

◆ getNumberOfLeafJawPairsTag()

std::string ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::getNumberOfLeafJawPairsTag ( ) const
inline

Definition at line 100 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

◆ getRTBeamLimitingDeviceType() [1/2]

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::getRTBeamLimitingDeviceType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRTBeamLimitingDeviceType() [2/2]

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::getRTBeamLimitingDeviceType ( unsigned long idx,
std::string & parameter ) const

◆ getRTBeamLimitingDeviceTypeTag()

std::string ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::getRTBeamLimitingDeviceTypeTag ( ) const
inline

Definition at line 106 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

◆ getSequence()

std::vector< DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item > ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::getSequence ( ) const
inline

Return the DRTBeamLimitingDeviceLeafPairsSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBeamLimitingDeviceLeafPairsSequence

Definition at line 118 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::hasSequence ( ) const
inline

Check if the DRTBeamLimitingDeviceLeafPairsSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 124 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::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 156 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::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 168 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

◆ setNumberOfLeafJawPairs()

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::setNumberOfLeafJawPairs ( unsigned long idx,
std::string parameter )

◆ setRTBeamLimitingDeviceType()

bool ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::setRTBeamLimitingDeviceType ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTBeamLimitingDeviceLeafPairsSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTBeamLimitingDeviceLeafPairsSequence

Definition at line 112 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

std::vector<DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::Item> ml::DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface::_itemVec
protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 180 of file mlDcmDRTBeamLimitingDeviceLeafPairsSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface(), DcmDRTBeamLimitingDeviceLeafPairsSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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