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

Class to provide access to DRTRangeModulatorSequence. More...

#include <mlDcmDRTRangeModulatorSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTRangeModulatorSequenceInterface ()
 
 DcmDRTRangeModulatorSequenceInterface (std::vector< DcmDRTRangeModulatorSequenceInterface::Item > dcmSequence)
 Default Constructor.
 
 DcmDRTRangeModulatorSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTRangeModulatorSequenceInterface ()
 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 getBeamCurrentModulationID (unsigned long idx, std::string &parameter) const
 
bool getBeamCurrentModulationID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getBeamCurrentModulationIDTag () const
 
bool setBeamCurrentModulationID (unsigned long idx, std::string parameter)
 
bool getRangeModulatorDescription (unsigned long idx, std::string &parameter) const
 
bool getRangeModulatorDescription (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeModulatorDescriptionTag () const
 
bool setRangeModulatorDescription (unsigned long idx, std::string parameter)
 
bool getRangeModulatorID (unsigned long idx, std::string &parameter) const
 
bool getRangeModulatorID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeModulatorIDTag () const
 
bool setRangeModulatorID (unsigned long idx, std::string parameter)
 
bool getRangeModulatorNumber (unsigned long idx, std::string &parameter) const
 
bool getRangeModulatorNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeModulatorNumberTag () const
 
bool setRangeModulatorNumber (unsigned long idx, std::string parameter)
 
bool getRangeModulatorType (unsigned long idx, std::string &parameter) const
 
bool getRangeModulatorType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeModulatorTypeTag () const
 
bool setRangeModulatorType (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTRangeModulatorSequenceInterface::Item > dcmSequence)
 Set the DRTRangeModulatorSequence this interface class provides access to.
 
std::vector< DcmDRTRangeModulatorSequenceInterface::Item > getSequence () const
 Return the DRTRangeModulatorSequence this interface class provides access to.
 
bool hasSequence () const
 Check if the DRTRangeModulatorSequence is set.
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
 
DcmDRTRangeModulatorSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position.
 
DcmDRTRangeModulatorSequenceInterface::Item & addItem ()
 Adds a new item to the sequence.
 
void addItem (DcmDRTRangeModulatorSequenceInterface::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< DcmDRTRangeModulatorSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.
 

Detailed Description

Class to provide access to DRTRangeModulatorSequence.

Definition at line 43 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRangeModulatorSequenceInterface() [1/3]

ml::DcmDRTRangeModulatorSequenceInterface::DcmDRTRangeModulatorSequenceInterface ( )
inline

Definition at line 103 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ DcmDRTRangeModulatorSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 106 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ DcmDRTRangeModulatorSequenceInterface() [3/3]

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

Definition at line 108 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ ~DcmDRTRangeModulatorSequenceInterface()

virtual ml::DcmDRTRangeModulatorSequenceInterface::~DcmDRTRangeModulatorSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 116 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 189 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 194 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

Definition at line 120 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Referenced by DRTRangeModulatorSequenceWrapper::getAccessoryCodeTag().

◆ getBeamCurrentModulationID() [1/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getBeamCurrentModulationID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getBeamCurrentModulationID() [2/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getBeamCurrentModulationID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getBeamCurrentModulationIDTag()

std::string ml::DcmDRTRangeModulatorSequenceInterface::getBeamCurrentModulationIDTag ( ) const
inline

Definition at line 126 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Referenced by DRTRangeModulatorSequenceWrapper::getBeamCurrentModulationIDTag().

◆ getItem()

DcmDRTRangeModulatorSequenceInterface::Item ml::DcmDRTRangeModulatorSequenceInterface::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 180 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTRangeModulatorSequenceInterface::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 174 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ getRangeModulatorDescription() [1/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorDescription ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeModulatorDescription() [2/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorDescription ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeModulatorDescriptionTag()

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorDescriptionTag ( ) const
inline

Definition at line 132 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Referenced by DRTRangeModulatorSequenceWrapper::getRangeModulatorDescriptionTag().

◆ getRangeModulatorID() [1/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeModulatorID() [2/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeModulatorIDTag()

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorIDTag ( ) const
inline

Definition at line 138 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Referenced by DRTRangeModulatorSequenceWrapper::getRangeModulatorIDTag().

◆ getRangeModulatorNumber() [1/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeModulatorNumber() [2/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeModulatorNumberTag()

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorNumberTag ( ) const
inline

Definition at line 144 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Referenced by DRTRangeModulatorSequenceWrapper::getRangeModulatorNumberTag().

◆ getRangeModulatorType() [1/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeModulatorType() [2/2]

bool ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeModulatorTypeTag()

std::string ml::DcmDRTRangeModulatorSequenceInterface::getRangeModulatorTypeTag ( ) const
inline

Definition at line 150 of file mlDcmDRTRangeModulatorSequenceInterface.h.

Referenced by DRTRangeModulatorSequenceWrapper::getRangeModulatorTypeTag().

◆ getSequence()

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

Return the DRTRangeModulatorSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRangeModulatorSequence

Definition at line 162 of file mlDcmDRTRangeModulatorSequenceInterface.h.

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

◆ hasSequence()

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

Check if the DRTRangeModulatorSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 168 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTRangeModulatorSequenceInterface::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 200 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTRangeModulatorSequenceInterface::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 212 of file mlDcmDRTRangeModulatorSequenceInterface.h.

◆ setAccessoryCode()

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

◆ setBeamCurrentModulationID()

bool ml::DcmDRTRangeModulatorSequenceInterface::setBeamCurrentModulationID ( unsigned long  idx,
std::string  parameter 
)

◆ setRangeModulatorDescription()

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorDescription ( unsigned long  idx,
std::string  parameter 
)

◆ setRangeModulatorID()

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorID ( unsigned long  idx,
std::string  parameter 
)

◆ setRangeModulatorNumber()

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setRangeModulatorType()

bool ml::DcmDRTRangeModulatorSequenceInterface::setRangeModulatorType ( unsigned long  idx,
std::string  parameter 
)

◆ setSequence()

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

Set the DRTRangeModulatorSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRangeModulatorSequence

Definition at line 156 of file mlDcmDRTRangeModulatorSequenceInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 224 of file mlDcmDRTRangeModulatorSequenceInterface.h.

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