MeVisLab Toolbox Reference
Classes | Public Member Functions | Protected Attributes | List of all members
ml::DcmDRTBlockSequenceInRTImageModuleInterface Class Reference

Class to provide access to DRTBlockSequenceInRTImageModule. More...

#include <mlDcmDRTBlockSequenceInRTImageModuleInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTBlockSequenceInRTImageModuleInterface ()
 
 DcmDRTBlockSequenceInRTImageModuleInterface (std::vector< DcmDRTBlockSequenceInRTImageModuleInterface::Item > dcmSequence)
 Default Constructor.
 
 DcmDRTBlockSequenceInRTImageModuleInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTBlockSequenceInRTImageModuleInterface ()
 Default virtual Destructor.
 
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 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< DcmDRTBlockSequenceInRTImageModuleInterface::Item > dcmSequence)
 Set the DRTBlockSequenceInRTImageModule this interface class provides access to.
 
std::vector< DcmDRTBlockSequenceInRTImageModuleInterface::Item > getSequence () const
 Return the DRTBlockSequenceInRTImageModule this interface class provides access to.
 
bool hasSequence () const
 Check if the DRTBlockSequenceInRTImageModule is set.
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
 
DcmDRTBlockSequenceInRTImageModuleInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position.
 
DcmDRTBlockSequenceInRTImageModuleInterface::Item & addItem ()
 Adds a new item to the sequence.
 
void addItem (DcmDRTBlockSequenceInRTImageModuleInterface::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< DcmDRTBlockSequenceInRTImageModuleInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.
 

Detailed Description

Class to provide access to DRTBlockSequenceInRTImageModule.

Definition at line 43 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTBlockSequenceInRTImageModuleInterface() [1/3]

ml::DcmDRTBlockSequenceInRTImageModuleInterface::DcmDRTBlockSequenceInRTImageModuleInterface ( )
inline

Definition at line 128 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ DcmDRTBlockSequenceInRTImageModuleInterface() [2/3]

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

Default Constructor.

Definition at line 131 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ DcmDRTBlockSequenceInRTImageModuleInterface() [3/3]

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

Definition at line 133 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ ~DcmDRTBlockSequenceInRTImageModuleInterface()

virtual ml::DcmDRTBlockSequenceInRTImageModuleInterface::~DcmDRTBlockSequenceInRTImageModuleInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 141 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 244 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ addItem() [2/2]

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

Definition at line 249 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ getBlockData() [1/2]

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

◆ getBlockData() [2/2]

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

◆ getBlockDataTag()

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

Definition at line 145 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockDataTag().

◆ getBlockDivergence() [1/2]

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

◆ getBlockDivergence() [2/2]

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

◆ getBlockDivergenceTag()

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

Definition at line 151 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockDivergenceTag().

◆ getBlockMountingPosition() [1/2]

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

◆ getBlockMountingPosition() [2/2]

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

◆ getBlockMountingPositionTag()

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

Definition at line 157 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockMountingPositionTag().

◆ getBlockName() [1/2]

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

◆ getBlockName() [2/2]

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

◆ getBlockNameTag()

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

Definition at line 163 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockNameTag().

◆ getBlockNumber() [1/2]

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

◆ getBlockNumber() [2/2]

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

◆ getBlockNumberOfPoints() [1/2]

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

◆ getBlockNumberOfPoints() [2/2]

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

◆ getBlockNumberOfPointsTag()

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

Definition at line 175 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockNumberOfPointsTag().

◆ getBlockNumberTag()

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

Definition at line 169 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockNumberTag().

◆ getBlockThickness() [1/2]

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

◆ getBlockThickness() [2/2]

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

◆ getBlockThicknessTag()

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

Definition at line 181 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockThicknessTag().

◆ getBlockTrayID() [1/2]

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

◆ getBlockTrayID() [2/2]

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

◆ getBlockTrayIDTag()

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

Definition at line 187 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockTrayIDTag().

◆ getBlockType() [1/2]

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

◆ getBlockType() [2/2]

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

◆ getBlockTypeTag()

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

Definition at line 193 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getBlockTypeTag().

◆ getItem()

DcmDRTBlockSequenceInRTImageModuleInterface::Item ml::DcmDRTBlockSequenceInRTImageModuleInterface::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 235 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ getMaterialID() [1/2]

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

◆ getMaterialID() [2/2]

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

◆ getMaterialIDTag()

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

Definition at line 199 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getMaterialIDTag().

◆ getNumberOfItems()

MLint ml::DcmDRTBlockSequenceInRTImageModuleInterface::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 229 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ getSequence()

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

Return the DRTBlockSequenceInRTImageModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTBlockSequenceInRTImageModule

Definition at line 217 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

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

◆ getSourceToBlockTrayDistance() [1/2]

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

◆ getSourceToBlockTrayDistance() [2/2]

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

◆ getSourceToBlockTrayDistanceTag()

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

Definition at line 205 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

Referenced by DRTBlockSequenceInRTImageModuleWrapper::getSourceToBlockTrayDistanceTag().

◆ hasSequence()

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

Check if the DRTBlockSequenceInRTImageModule is set.

Returns
True if internal pointer is set, False else.

Definition at line 223 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ insertItem()

bool ml::DcmDRTBlockSequenceInRTImageModuleInterface::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 255 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ removeItem()

bool ml::DcmDRTBlockSequenceInRTImageModuleInterface::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 267 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

◆ setBlockData()

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

◆ setBlockDivergence()

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

◆ setBlockMountingPosition()

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

◆ setBlockName()

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

◆ setBlockNumber()

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

◆ setBlockNumberOfPoints()

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

◆ setBlockThickness()

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

◆ setBlockTrayID()

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

◆ setBlockType()

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

◆ setMaterialID()

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

◆ setSequence()

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

Set the DRTBlockSequenceInRTImageModule this interface class provides access to.

Parameters
dcmSequencePointer to DRTBlockSequenceInRTImageModule

Definition at line 211 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

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

◆ setSourceToBlockTrayDistance()

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 279 of file mlDcmDRTBlockSequenceInRTImageModuleInterface.h.

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