MeVisLab Toolbox Reference
ml::DcmDRTBlockSequenceInRTBeamsModuleInterface Class Reference

Class to provide access to DRTBlockSequenceInRTBeamsModule. More...

#include <mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTBlockSequenceInRTBeamsModuleInterface ()
 DcmDRTBlockSequenceInRTBeamsModuleInterface (std::vector< DcmDRTBlockSequenceInRTBeamsModuleInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTBlockSequenceInRTBeamsModuleInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTBlockSequenceInRTBeamsModuleInterface ()
 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 getBlockData (unsigned long idx, std::string &parameter) const
bool getBlockData (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockDataTag () const
bool setBlockData (unsigned long idx, std::string parameter)
bool getBlockDivergence (unsigned long idx, std::string &parameter) const
bool getBlockDivergence (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockDivergenceTag () const
bool setBlockDivergence (unsigned long idx, std::string parameter)
bool getBlockMountingPosition (unsigned long idx, std::string &parameter) const
bool getBlockMountingPosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockMountingPositionTag () const
bool setBlockMountingPosition (unsigned long idx, std::string parameter)
bool getBlockName (unsigned long idx, std::string &parameter) const
bool getBlockName (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockNameTag () const
bool setBlockName (unsigned long idx, std::string parameter)
bool getBlockNumber (unsigned long idx, std::string &parameter) const
bool getBlockNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockNumberTag () const
bool setBlockNumber (unsigned long idx, std::string parameter)
bool getBlockNumberOfPoints (unsigned long idx, std::string &parameter) const
bool getBlockNumberOfPoints (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockNumberOfPointsTag () const
bool setBlockNumberOfPoints (unsigned long idx, std::string parameter)
bool getBlockThickness (unsigned long idx, std::string &parameter) const
bool getBlockThickness (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockThicknessTag () const
bool setBlockThickness (unsigned long idx, std::string parameter)
bool getBlockTransmission (unsigned long idx, std::string &parameter) const
bool getBlockTransmission (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockTransmissionTag () const
bool setBlockTransmission (unsigned long idx, std::string parameter)
bool getBlockTrayID (unsigned long idx, std::string &parameter) const
bool getBlockTrayID (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockTrayIDTag () const
bool setBlockTrayID (unsigned long idx, std::string parameter)
bool getBlockType (unsigned long idx, std::string &parameter) const
bool getBlockType (DCMTree::TreePtr item, std::string &parameter) const
std::string getBlockTypeTag () const
bool setBlockType (unsigned long idx, std::string parameter)
bool getMaterialID (unsigned long idx, std::string &parameter) const
bool getMaterialID (DCMTree::TreePtr item, std::string &parameter) const
std::string getMaterialIDTag () const
bool setMaterialID (unsigned long idx, std::string parameter)
bool getSourceToBlockTrayDistance (unsigned long idx, std::string &parameter) const
bool getSourceToBlockTrayDistance (DCMTree::TreePtr item, std::string &parameter) const
std::string getSourceToBlockTrayDistanceTag () const
bool setSourceToBlockTrayDistance (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTBlockSequenceInRTBeamsModuleInterface::Item > dcmSequence)
std::vector< DcmDRTBlockSequenceInRTBeamsModuleInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTBlockSequenceInRTBeamsModuleInterface::Item getItem (const size_t idx) const
DcmDRTBlockSequenceInRTBeamsModuleInterface::Item & addItem ()
void addItem (DcmDRTBlockSequenceInRTBeamsModuleInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTBlockSequenceInRTBeamsModule.

Definition at line 43 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTBlockSequenceInRTBeamsModuleInterface() [1/3]

ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::DcmDRTBlockSequenceInRTBeamsModuleInterface ( )
inline

Definition at line 138 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ DcmDRTBlockSequenceInRTBeamsModuleInterface() [2/3]

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

Default Constructor.

Definition at line 141 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ DcmDRTBlockSequenceInRTBeamsModuleInterface() [3/3]

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

Definition at line 143 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ ~DcmDRTBlockSequenceInRTBeamsModuleInterface()

virtual ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::~DcmDRTBlockSequenceInRTBeamsModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 151 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 266 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 271 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getAccessoryCodeTag ( ) const
inline

Definition at line 155 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockData() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockData ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockData() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockData ( unsigned long idx,
std::string & parameter ) const

◆ getBlockDataTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockDataTag ( ) const
inline

Definition at line 161 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockDivergence() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockDivergence ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockDivergence() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockDivergence ( unsigned long idx,
std::string & parameter ) const

◆ getBlockDivergenceTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockDivergenceTag ( ) const
inline

Definition at line 167 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockMountingPosition() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockMountingPosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockMountingPosition() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockMountingPosition ( unsigned long idx,
std::string & parameter ) const

◆ getBlockMountingPositionTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockMountingPositionTag ( ) const
inline

Definition at line 173 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockName() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockName() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockName ( unsigned long idx,
std::string & parameter ) const

◆ getBlockNameTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockNameTag ( ) const
inline

Definition at line 179 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockNumber() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockNumber() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockNumber ( unsigned long idx,
std::string & parameter ) const

◆ getBlockNumberOfPoints() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockNumberOfPoints ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockNumberOfPoints() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockNumberOfPoints ( unsigned long idx,
std::string & parameter ) const

◆ getBlockNumberOfPointsTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockNumberOfPointsTag ( ) const
inline

Definition at line 191 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockNumberTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockNumberTag ( ) const
inline

Definition at line 185 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockThickness() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockThickness ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockThickness() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockThickness ( unsigned long idx,
std::string & parameter ) const

◆ getBlockThicknessTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockThicknessTag ( ) const
inline

Definition at line 197 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockTransmission() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockTransmission ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockTransmission() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockTransmission ( unsigned long idx,
std::string & parameter ) const

◆ getBlockTransmissionTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockTransmissionTag ( ) const
inline

Definition at line 203 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockTrayID() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockTrayID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockTrayID() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockTrayID ( unsigned long idx,
std::string & parameter ) const

◆ getBlockTrayIDTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockTrayIDTag ( ) const
inline

Definition at line 209 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getBlockType() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockType ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getBlockType() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockType ( unsigned long idx,
std::string & parameter ) const

◆ getBlockTypeTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getBlockTypeTag ( ) const
inline

Definition at line 215 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getItem()

DcmDRTBlockSequenceInRTBeamsModuleInterface::Item ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::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 257 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ getMaterialID() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getMaterialID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getMaterialID() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getMaterialID ( unsigned long idx,
std::string & parameter ) const

◆ getMaterialIDTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getMaterialIDTag ( ) const
inline

Definition at line 221 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::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 251 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ getSequence()

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

Return the DRTBlockSequenceInRTBeamsModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTBlockSequenceInRTBeamsModule

Definition at line 239 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

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

◆ getSourceToBlockTrayDistance() [1/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getSourceToBlockTrayDistance ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getSourceToBlockTrayDistance() [2/2]

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getSourceToBlockTrayDistance ( unsigned long idx,
std::string & parameter ) const

◆ getSourceToBlockTrayDistanceTag()

std::string ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::getSourceToBlockTrayDistanceTag ( ) const
inline

Definition at line 227 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

◆ hasSequence()

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

Check if the DRTBlockSequenceInRTBeamsModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 245 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::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 277 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::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 289 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ setAccessoryCode()

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

◆ setBlockData()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockData ( unsigned long idx,
std::string parameter )

◆ setBlockDivergence()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockDivergence ( unsigned long idx,
std::string parameter )

◆ setBlockMountingPosition()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockMountingPosition ( unsigned long idx,
std::string parameter )

◆ setBlockName()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockName ( unsigned long idx,
std::string parameter )

◆ setBlockNumber()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockNumber ( unsigned long idx,
std::string parameter )

◆ setBlockNumberOfPoints()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockNumberOfPoints ( unsigned long idx,
std::string parameter )

◆ setBlockThickness()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockThickness ( unsigned long idx,
std::string parameter )

◆ setBlockTransmission()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockTransmission ( unsigned long idx,
std::string parameter )

◆ setBlockTrayID()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockTrayID ( unsigned long idx,
std::string parameter )

◆ setBlockType()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setBlockType ( unsigned long idx,
std::string parameter )

◆ setMaterialID()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setMaterialID ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTBlockSequenceInRTBeamsModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTBlockSequenceInRTBeamsModule

Definition at line 233 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

References _itemVec.

◆ setSourceToBlockTrayDistance()

bool ml::DcmDRTBlockSequenceInRTBeamsModuleInterface::setSourceToBlockTrayDistance ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 301 of file mlDcmDRTBlockSequenceInRTBeamsModuleInterface.h.

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

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