MeVisLab Toolbox Reference
ml::DcmDRTShieldingDeviceSequenceInterface Class Reference

Class to provide access to DRTShieldingDeviceSequence. More...

#include <mlDcmDRTShieldingDeviceSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTShieldingDeviceSequenceInterface ()
 
 DcmDRTShieldingDeviceSequenceInterface (std::vector< DcmDRTShieldingDeviceSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTShieldingDeviceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTShieldingDeviceSequenceInterface ()
 Default virtual Destructor. More...
 
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 getShieldingDeviceDescription (unsigned long idx, std::string &parameter) const
 
bool getShieldingDeviceDescription (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getShieldingDeviceDescriptionTag () const
 
bool setShieldingDeviceDescription (unsigned long idx, std::string parameter)
 
bool getShieldingDeviceLabel (unsigned long idx, std::string &parameter) const
 
bool getShieldingDeviceLabel (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getShieldingDeviceLabelTag () const
 
bool setShieldingDeviceLabel (unsigned long idx, std::string parameter)
 
bool getShieldingDevicePosition (unsigned long idx, std::string &parameter) const
 
bool getShieldingDevicePosition (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getShieldingDevicePositionTag () const
 
bool setShieldingDevicePosition (unsigned long idx, std::string parameter)
 
bool getShieldingDeviceType (unsigned long idx, std::string &parameter) const
 
bool getShieldingDeviceType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getShieldingDeviceTypeTag () const
 
bool setShieldingDeviceType (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTShieldingDeviceSequenceInterface::Item > dcmSequence)
 Set the DRTShieldingDeviceSequence this interface class provides access to. More...
 
std::vector< DcmDRTShieldingDeviceSequenceInterface::ItemgetSequence () const
 Return the DRTShieldingDeviceSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTShieldingDeviceSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTShieldingDeviceSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTShieldingDeviceSequenceInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTShieldingDeviceSequenceInterface::Item newItem)
 
bool insertItem (const size_t idx)
 Insert an item at the indicated position. More...
 
bool removeItem (const size_t idx)
 Removes the indicated item from the sequence. More...
 

Protected Attributes

std::vector< DcmDRTShieldingDeviceSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTShieldingDeviceSequence.

Definition at line 43 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTShieldingDeviceSequenceInterface() [1/3]

ml::DcmDRTShieldingDeviceSequenceInterface::DcmDRTShieldingDeviceSequenceInterface ( )
inline

Definition at line 98 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ DcmDRTShieldingDeviceSequenceInterface() [2/3]

ml::DcmDRTShieldingDeviceSequenceInterface::DcmDRTShieldingDeviceSequenceInterface ( std::vector< DcmDRTShieldingDeviceSequenceInterface::Item dcmSequence)
inline

Default Constructor.

Definition at line 101 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ DcmDRTShieldingDeviceSequenceInterface() [3/3]

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

Definition at line 103 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ ~DcmDRTShieldingDeviceSequenceInterface()

virtual ml::DcmDRTShieldingDeviceSequenceInterface::~DcmDRTShieldingDeviceSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 178 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 183 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

◆ getItem()

DcmDRTShieldingDeviceSequenceInterface::Item ml::DcmDRTShieldingDeviceSequenceInterface::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 169 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTShieldingDeviceSequenceInterface::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 163 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ getSequence()

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

Return the DRTShieldingDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTShieldingDeviceSequence

Definition at line 151 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

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

◆ getShieldingDeviceDescription() [1/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceDescription ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getShieldingDeviceDescription() [2/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceDescription ( unsigned long  idx,
std::string &  parameter 
) const

◆ getShieldingDeviceDescriptionTag()

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceDescriptionTag ( ) const
inline

◆ getShieldingDeviceLabel() [1/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceLabel ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getShieldingDeviceLabel() [2/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceLabel ( unsigned long  idx,
std::string &  parameter 
) const

◆ getShieldingDeviceLabelTag()

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceLabelTag ( ) const
inline

◆ getShieldingDevicePosition() [1/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDevicePosition ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getShieldingDevicePosition() [2/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDevicePosition ( unsigned long  idx,
std::string &  parameter 
) const

◆ getShieldingDevicePositionTag()

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDevicePositionTag ( ) const
inline

◆ getShieldingDeviceType() [1/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getShieldingDeviceType() [2/2]

bool ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getShieldingDeviceTypeTag()

std::string ml::DcmDRTShieldingDeviceSequenceInterface::getShieldingDeviceTypeTag ( ) const
inline

◆ hasSequence()

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

Check if the DRTShieldingDeviceSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTShieldingDeviceSequenceInterface::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 189 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTShieldingDeviceSequenceInterface::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 201 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

◆ setAccessoryCode()

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

◆ setSequence()

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

Set the DRTShieldingDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTShieldingDeviceSequence

Definition at line 145 of file mlDcmDRTShieldingDeviceSequenceInterface.h.

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

◆ setShieldingDeviceDescription()

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDeviceDescription ( unsigned long  idx,
std::string  parameter 
)

◆ setShieldingDeviceLabel()

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDeviceLabel ( unsigned long  idx,
std::string  parameter 
)

◆ setShieldingDevicePosition()

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDevicePosition ( unsigned long  idx,
std::string  parameter 
)

◆ setShieldingDeviceType()

bool ml::DcmDRTShieldingDeviceSequenceInterface::setShieldingDeviceType ( unsigned long  idx,
std::string  parameter 
)

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTShieldingDeviceSequenceInterface.h.


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