MeVisLab Toolbox Reference
ml::DcmDRTRangeShifterSequenceInterface Class Reference

Class to provide access to DRTRangeShifterSequence. More...

#include <mlDcmDRTRangeShifterSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTRangeShifterSequenceInterface ()
 
 DcmDRTRangeShifterSequenceInterface (std::vector< DcmDRTRangeShifterSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTRangeShifterSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTRangeShifterSequenceInterface ()
 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 getRangeShifterDescription (unsigned long idx, std::string &parameter) const
 
bool getRangeShifterDescription (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeShifterDescriptionTag () const
 
bool setRangeShifterDescription (unsigned long idx, std::string parameter)
 
bool getRangeShifterID (unsigned long idx, std::string &parameter) const
 
bool getRangeShifterID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeShifterIDTag () const
 
bool setRangeShifterID (unsigned long idx, std::string parameter)
 
bool getRangeShifterNumber (unsigned long idx, std::string &parameter) const
 
bool getRangeShifterNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeShifterNumberTag () const
 
bool setRangeShifterNumber (unsigned long idx, std::string parameter)
 
bool getRangeShifterType (unsigned long idx, std::string &parameter) const
 
bool getRangeShifterType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getRangeShifterTypeTag () const
 
bool setRangeShifterType (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTRangeShifterSequenceInterface::Item > dcmSequence)
 Set the DRTRangeShifterSequence this interface class provides access to. More...
 
std::vector< DcmDRTRangeShifterSequenceInterface::ItemgetSequence () const
 Return the DRTRangeShifterSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTRangeShifterSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTRangeShifterSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTRangeShifterSequenceInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTRangeShifterSequenceInterface::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< DcmDRTRangeShifterSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTRangeShifterSequence.

Definition at line 43 of file mlDcmDRTRangeShifterSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRangeShifterSequenceInterface() [1/3]

ml::DcmDRTRangeShifterSequenceInterface::DcmDRTRangeShifterSequenceInterface ( )
inline

Definition at line 98 of file mlDcmDRTRangeShifterSequenceInterface.h.

◆ DcmDRTRangeShifterSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 101 of file mlDcmDRTRangeShifterSequenceInterface.h.

◆ DcmDRTRangeShifterSequenceInterface() [3/3]

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

Definition at line 103 of file mlDcmDRTRangeShifterSequenceInterface.h.

◆ ~DcmDRTRangeShifterSequenceInterface()

virtual ml::DcmDRTRangeShifterSequenceInterface::~DcmDRTRangeShifterSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 111 of file mlDcmDRTRangeShifterSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTRangeShifterSequenceInterface::Item& ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 183 of file mlDcmDRTRangeShifterSequenceInterface.h.

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

◆ getItem()

DcmDRTRangeShifterSequenceInterface::Item ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

◆ getRangeShifterDescription() [1/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterDescription ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeShifterDescription() [2/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterDescription ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeShifterDescriptionTag()

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterDescriptionTag ( ) const
inline

◆ getRangeShifterID() [1/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeShifterID() [2/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeShifterIDTag()

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterIDTag ( ) const
inline

◆ getRangeShifterNumber() [1/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeShifterNumber() [2/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeShifterNumberTag()

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterNumberTag ( ) const
inline

◆ getRangeShifterType() [1/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getRangeShifterType() [2/2]

bool ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getRangeShifterTypeTag()

std::string ml::DcmDRTRangeShifterSequenceInterface::getRangeShifterTypeTag ( ) const
inline

◆ getSequence()

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

Return the DRTRangeShifterSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRangeShifterSequence

Definition at line 151 of file mlDcmDRTRangeShifterSequenceInterface.h.

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

◆ hasSequence()

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

Check if the DRTRangeShifterSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 157 of file mlDcmDRTRangeShifterSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTRangeShifterSequenceInterface::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 mlDcmDRTRangeShifterSequenceInterface.h.

◆ setAccessoryCode()

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

◆ setRangeShifterDescription()

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterDescription ( unsigned long  idx,
std::string  parameter 
)

◆ setRangeShifterID()

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterID ( unsigned long  idx,
std::string  parameter 
)

◆ setRangeShifterNumber()

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setRangeShifterType()

bool ml::DcmDRTRangeShifterSequenceInterface::setRangeShifterType ( unsigned long  idx,
std::string  parameter 
)

◆ setSequence()

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

Set the DRTRangeShifterSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRangeShifterSequence

Definition at line 145 of file mlDcmDRTRangeShifterSequenceInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 213 of file mlDcmDRTRangeShifterSequenceInterface.h.


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