MeVisLab Toolbox Reference
ml::DcmDRTIonBlockSequenceInterface Class Reference

Class to provide access to DRTIonBlockSequence. More...

#include <mlDcmDRTIonBlockSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTIonBlockSequenceInterface ()
 DcmDRTIonBlockSequenceInterface (std::vector< DcmDRTIonBlockSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTIonBlockSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTIonBlockSequenceInterface ()
 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 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 getIsocenterToBlockTrayDistance (unsigned long idx, float &parameter) const
bool getIsocenterToBlockTrayDistance (DCMTree::TreePtr item, float &parameter) const
std::string getIsocenterToBlockTrayDistanceTag () const
bool setIsocenterToBlockTrayDistance (unsigned long idx, float 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)
void setSequence (std::vector< DcmDRTIonBlockSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTIonBlockSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTIonBlockSequenceInterface::Item getItem (const size_t idx) const
DcmDRTIonBlockSequenceInterface::Item & addItem ()
void addItem (DcmDRTIonBlockSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTIonBlockSequence.

Definition at line 43 of file mlDcmDRTIonBlockSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTIonBlockSequenceInterface() [1/3]

ml::DcmDRTIonBlockSequenceInterface::DcmDRTIonBlockSequenceInterface ( )
inline

Definition at line 133 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ DcmDRTIonBlockSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 136 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ DcmDRTIonBlockSequenceInterface() [3/3]

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

Definition at line 138 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTIonBlockSequenceInterface()

virtual ml::DcmDRTIonBlockSequenceInterface::~DcmDRTIonBlockSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 146 of file mlDcmDRTIonBlockSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 255 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 260 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

Definition at line 150 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockData() [1/2]

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

◆ getBlockData() [2/2]

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

◆ getBlockDataTag()

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

Definition at line 156 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockDivergence() [1/2]

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

◆ getBlockDivergence() [2/2]

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

◆ getBlockDivergenceTag()

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

Definition at line 162 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockMountingPosition() [1/2]

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

◆ getBlockMountingPosition() [2/2]

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

◆ getBlockMountingPositionTag()

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

Definition at line 168 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockName() [1/2]

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

◆ getBlockName() [2/2]

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

◆ getBlockNameTag()

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

Definition at line 174 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockNumber() [1/2]

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

◆ getBlockNumber() [2/2]

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

◆ getBlockNumberOfPoints() [1/2]

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

◆ getBlockNumberOfPoints() [2/2]

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

◆ getBlockNumberOfPointsTag()

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

Definition at line 186 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockNumberTag()

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

Definition at line 180 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockThickness() [1/2]

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

◆ getBlockThickness() [2/2]

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

◆ getBlockThicknessTag()

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

Definition at line 192 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockTrayID() [1/2]

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

◆ getBlockTrayID() [2/2]

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

◆ getBlockTrayIDTag()

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

Definition at line 198 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getBlockType() [1/2]

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

◆ getBlockType() [2/2]

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

◆ getBlockTypeTag()

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

Definition at line 204 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getIsocenterToBlockTrayDistance() [1/2]

bool ml::DcmDRTIonBlockSequenceInterface::getIsocenterToBlockTrayDistance ( DCMTree::TreePtr item,
float & parameter ) const

◆ getIsocenterToBlockTrayDistance() [2/2]

bool ml::DcmDRTIonBlockSequenceInterface::getIsocenterToBlockTrayDistance ( unsigned long idx,
float & parameter ) const

◆ getIsocenterToBlockTrayDistanceTag()

std::string ml::DcmDRTIonBlockSequenceInterface::getIsocenterToBlockTrayDistanceTag ( ) const
inline

Definition at line 210 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getItem()

DcmDRTIonBlockSequenceInterface::Item ml::DcmDRTIonBlockSequenceInterface::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 246 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ getMaterialID() [1/2]

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

◆ getMaterialID() [2/2]

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

◆ getMaterialIDTag()

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

Definition at line 216 of file mlDcmDRTIonBlockSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTIonBlockSequenceInterface::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 240 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ getSequence()

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

Return the DRTIonBlockSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonBlockSequence

Definition at line 228 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

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

◆ hasSequence()

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

Check if the DRTIonBlockSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 234 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTIonBlockSequenceInterface::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 266 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTIonBlockSequenceInterface::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 278 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

◆ setAccessoryCode()

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

◆ setBlockData()

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

◆ setBlockDivergence()

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

◆ setBlockMountingPosition()

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

◆ setBlockName()

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

◆ setBlockNumber()

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

◆ setBlockNumberOfPoints()

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

◆ setBlockThickness()

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

◆ setBlockTrayID()

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

◆ setBlockType()

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

◆ setIsocenterToBlockTrayDistance()

bool ml::DcmDRTIonBlockSequenceInterface::setIsocenterToBlockTrayDistance ( unsigned long idx,
float parameter )

◆ setMaterialID()

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

◆ setSequence()

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

Set the DRTIonBlockSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTIonBlockSequence

Definition at line 222 of file mlDcmDRTIonBlockSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 290 of file mlDcmDRTIonBlockSequenceInterface.h.

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

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