MeVisLab Toolbox Reference
ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface Class Reference

Class to provide access to DRTRecordedLateralSpreadingDeviceSequence. More...

#include <mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ()
 
 DcmDRTRecordedLateralSpreadingDeviceSequenceInterface (std::vector< DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTRecordedLateralSpreadingDeviceSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ()
 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 getLateralSpreadingDeviceID (unsigned long idx, std::string &parameter) const
 
bool getLateralSpreadingDeviceID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getLateralSpreadingDeviceIDTag () const
 
bool setLateralSpreadingDeviceID (unsigned long idx, std::string parameter)
 
bool getReferencedLateralSpreadingDeviceNumber (unsigned long idx, std::string &parameter) const
 
bool getReferencedLateralSpreadingDeviceNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getReferencedLateralSpreadingDeviceNumberTag () const
 
bool setReferencedLateralSpreadingDeviceNumber (unsigned long idx, std::string parameter)
 
void setSequence (std::vector< DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item > dcmSequence)
 Set the DRTRecordedLateralSpreadingDeviceSequence this interface class provides access to. More...
 
std::vector< DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::ItemgetSequence () const
 Return the DRTRecordedLateralSpreadingDeviceSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTRecordedLateralSpreadingDeviceSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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< DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTRecordedLateralSpreadingDeviceSequence.

Definition at line 43 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRecordedLateralSpreadingDeviceSequenceInterface() [1/3]

ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ( )
inline

◆ DcmDRTRecordedLateralSpreadingDeviceSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 91 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

◆ DcmDRTRecordedLateralSpreadingDeviceSequenceInterface() [3/3]

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

◆ ~DcmDRTRecordedLateralSpreadingDeviceSequenceInterface()

virtual ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::~DcmDRTRecordedLateralSpreadingDeviceSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 156 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

◆ addItem() [2/2]

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

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

◆ getItem()

DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::Item ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 147 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

◆ getLateralSpreadingDeviceID() [1/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getLateralSpreadingDeviceID() [2/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getLateralSpreadingDeviceIDTag()

std::string ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getLateralSpreadingDeviceIDTag ( ) const
inline

◆ getNumberOfItems()

MLint ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 141 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

◆ getReferencedLateralSpreadingDeviceNumber() [1/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getReferencedLateralSpreadingDeviceNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getReferencedLateralSpreadingDeviceNumber() [2/2]

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getReferencedLateralSpreadingDeviceNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getReferencedLateralSpreadingDeviceNumberTag()

std::string ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::getReferencedLateralSpreadingDeviceNumberTag ( ) const
inline

◆ getSequence()

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

Return the DRTRecordedLateralSpreadingDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRecordedLateralSpreadingDeviceSequence

Definition at line 129 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

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

◆ hasSequence()

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

Check if the DRTRecordedLateralSpreadingDeviceSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 167 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::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 179 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

◆ setAccessoryCode()

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

◆ setLateralSpreadingDeviceID()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::setLateralSpreadingDeviceID ( unsigned long  idx,
std::string  parameter 
)

◆ setReferencedLateralSpreadingDeviceNumber()

bool ml::DcmDRTRecordedLateralSpreadingDeviceSequenceInterface::setReferencedLateralSpreadingDeviceNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setSequence()

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

Set the DRTRecordedLateralSpreadingDeviceSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRecordedLateralSpreadingDeviceSequence

Definition at line 123 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTRecordedLateralSpreadingDeviceSequenceInterface.h.


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