MeVisLab Toolbox Reference
ml::DcmDRTRecordedCompensatorSequenceInterface Class Reference

Class to provide access to DRTRecordedCompensatorSequence. More...

#include <mlDcmDRTRecordedCompensatorSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

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

Detailed Description

Class to provide access to DRTRecordedCompensatorSequence.

Definition at line 43 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRecordedCompensatorSequenceInterface() [1/3]

ml::DcmDRTRecordedCompensatorSequenceInterface::DcmDRTRecordedCompensatorSequenceInterface ( )
inline

◆ DcmDRTRecordedCompensatorSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 91 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

◆ DcmDRTRecordedCompensatorSequenceInterface() [3/3]

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

◆ ~DcmDRTRecordedCompensatorSequenceInterface()

virtual ml::DcmDRTRecordedCompensatorSequenceInterface::~DcmDRTRecordedCompensatorSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTRecordedCompensatorSequenceInterface::Item& ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

◆ addItem() [2/2]

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

◆ getAccessoryCode() [1/2]

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

◆ getAccessoryCode() [2/2]

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

◆ getAccessoryCodeTag()

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

◆ getCompensatorID() [1/2]

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getCompensatorID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getCompensatorID() [2/2]

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getCompensatorID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getCompensatorIDTag()

std::string ml::DcmDRTRecordedCompensatorSequenceInterface::getCompensatorIDTag ( ) const
inline

◆ getItem()

DcmDRTRecordedCompensatorSequenceInterface::Item ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

◆ getReferencedCompensatorNumber() [1/2]

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getReferencedCompensatorNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getReferencedCompensatorNumber() [2/2]

bool ml::DcmDRTRecordedCompensatorSequenceInterface::getReferencedCompensatorNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getReferencedCompensatorNumberTag()

std::string ml::DcmDRTRecordedCompensatorSequenceInterface::getReferencedCompensatorNumberTag ( ) const
inline

◆ getSequence()

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

Return the DRTRecordedCompensatorSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRecordedCompensatorSequence

Definition at line 129 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

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

◆ hasSequence()

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

Check if the DRTRecordedCompensatorSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTRecordedCompensatorSequenceInterface::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 mlDcmDRTRecordedCompensatorSequenceInterface.h.

◆ setAccessoryCode()

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

◆ setCompensatorID()

bool ml::DcmDRTRecordedCompensatorSequenceInterface::setCompensatorID ( unsigned long  idx,
std::string  parameter 
)

◆ setReferencedCompensatorNumber()

bool ml::DcmDRTRecordedCompensatorSequenceInterface::setReferencedCompensatorNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setSequence()

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

Set the DRTRecordedCompensatorSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRecordedCompensatorSequence

Definition at line 123 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTRecordedCompensatorSequenceInterface.h.


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