MeVisLab Toolbox Reference
ml::DcmDRTContentItemModifierSequenceInterface Class Reference

Class to provide access to DRTContentItemModifierSequence. More...

#include <mlDcmDRTContentItemModifierSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTContentItemModifierSequenceInterface ()
 
 DcmDRTContentItemModifierSequenceInterface (std::vector< DcmDRTContentItemModifierSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTContentItemModifierSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTContentItemModifierSequenceInterface ()
 Default virtual Destructor. More...
 
bool getDate (unsigned long idx, std::string &parameter) const
 
bool getDate (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDateTag () const
 
bool setDate (unsigned long idx, std::string parameter)
 
bool getDateTime (unsigned long idx, std::string &parameter) const
 
bool getDateTime (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDateTimeTag () const
 
bool setDateTime (unsigned long idx, std::string parameter)
 
bool getNumericValue (unsigned long idx, std::string &parameter) const
 
bool getNumericValue (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getNumericValueTag () const
 
bool setNumericValue (unsigned long idx, std::string parameter)
 
bool getPersonName (unsigned long idx, std::string &parameter) const
 
bool getPersonName (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getPersonNameTag () const
 
bool setPersonName (unsigned long idx, std::string parameter)
 
bool getTextValue (unsigned long idx, std::string &parameter) const
 
bool getTextValue (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTextValueTag () const
 
bool setTextValue (unsigned long idx, std::string parameter)
 
bool getTime (unsigned long idx, std::string &parameter) const
 
bool getTime (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTimeTag () const
 
bool setTime (unsigned long idx, std::string parameter)
 
bool getUID (unsigned long idx, std::string &parameter) const
 
bool getUID (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getUIDTag () const
 
bool setUID (unsigned long idx, std::string parameter)
 
bool getValueType (unsigned long idx, std::string &parameter) const
 
bool getValueType (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getValueTypeTag () const
 
bool setValueType (unsigned long idx, std::string parameter)
 
DcmDRTConceptCodeSequenceInterface getConceptCodeSequence (unsigned long idx) const
 
std::string getConceptCodeSequenceTag () const
 
void setConceptCodeSequence (DcmDRTConceptCodeSequenceInterface seq, unsigned long idx)
 
DcmDRTConceptNameCodeSequenceInterface getConceptNameCodeSequence (unsigned long idx) const
 
std::string getConceptNameCodeSequenceTag () const
 
void setConceptNameCodeSequence (DcmDRTConceptNameCodeSequenceInterface seq, unsigned long idx)
 
DcmDRTMeasurementUnitsCodeSequenceInterface getMeasurementUnitsCodeSequence (unsigned long idx) const
 
std::string getMeasurementUnitsCodeSequenceTag () const
 
void setMeasurementUnitsCodeSequence (DcmDRTMeasurementUnitsCodeSequenceInterface seq, unsigned long idx)
 
void setSequence (std::vector< DcmDRTContentItemModifierSequenceInterface::Item > dcmSequence)
 Set the DRTContentItemModifierSequence this interface class provides access to. More...
 
std::vector< DcmDRTContentItemModifierSequenceInterface::ItemgetSequence () const
 Return the DRTContentItemModifierSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTContentItemModifierSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTContentItemModifierSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTContentItemModifierSequenceInterface::ItemaddItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTContentItemModifierSequenceInterface::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< DcmDRTContentItemModifierSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTContentItemModifierSequence.

Definition at line 46 of file mlDcmDRTContentItemModifierSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTContentItemModifierSequenceInterface() [1/3]

ml::DcmDRTContentItemModifierSequenceInterface::DcmDRTContentItemModifierSequenceInterface ( )
inline

◆ DcmDRTContentItemModifierSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 134 of file mlDcmDRTContentItemModifierSequenceInterface.h.

◆ DcmDRTContentItemModifierSequenceInterface() [3/3]

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

◆ ~DcmDRTContentItemModifierSequenceInterface()

virtual ml::DcmDRTContentItemModifierSequenceInterface::~DcmDRTContentItemModifierSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 144 of file mlDcmDRTContentItemModifierSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 244 of file mlDcmDRTContentItemModifierSequenceInterface.h.

◆ addItem() [2/2]

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

◆ getConceptCodeSequence()

DcmDRTConceptCodeSequenceInterface ml::DcmDRTContentItemModifierSequenceInterface::getConceptCodeSequence ( unsigned long  idx) const

◆ getConceptCodeSequenceTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getConceptCodeSequenceTag ( ) const
inline

◆ getConceptNameCodeSequence()

DcmDRTConceptNameCodeSequenceInterface ml::DcmDRTContentItemModifierSequenceInterface::getConceptNameCodeSequence ( unsigned long  idx) const

◆ getConceptNameCodeSequenceTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getConceptNameCodeSequenceTag ( ) const
inline

◆ getDate() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getDate ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDate() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getDate ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDateTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getDateTag ( ) const
inline

◆ getDateTime() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getDateTime ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDateTime() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getDateTime ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDateTimeTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getDateTimeTag ( ) const
inline

◆ getItem()

DcmDRTContentItemModifierSequenceInterface::Item ml::DcmDRTContentItemModifierSequenceInterface::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 235 of file mlDcmDRTContentItemModifierSequenceInterface.h.

◆ getMeasurementUnitsCodeSequence()

DcmDRTMeasurementUnitsCodeSequenceInterface ml::DcmDRTContentItemModifierSequenceInterface::getMeasurementUnitsCodeSequence ( unsigned long  idx) const

◆ getMeasurementUnitsCodeSequenceTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getMeasurementUnitsCodeSequenceTag ( ) const
inline

◆ getNumberOfItems()

MLint ml::DcmDRTContentItemModifierSequenceInterface::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 229 of file mlDcmDRTContentItemModifierSequenceInterface.h.

◆ getNumericValue() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getNumericValue ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getNumericValue() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getNumericValue ( unsigned long  idx,
std::string &  parameter 
) const

◆ getNumericValueTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getNumericValueTag ( ) const
inline

◆ getPersonName() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getPersonName ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getPersonName() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getPersonName ( unsigned long  idx,
std::string &  parameter 
) const

◆ getPersonNameTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getPersonNameTag ( ) const
inline

◆ getSequence()

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

Return the DRTContentItemModifierSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTContentItemModifierSequence

Definition at line 217 of file mlDcmDRTContentItemModifierSequenceInterface.h.

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

◆ getTextValue() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getTextValue ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTextValue() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getTextValue ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTextValueTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getTextValueTag ( ) const
inline

◆ getTime() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getTime ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTime() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getTime ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTimeTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getTimeTag ( ) const
inline

◆ getUID() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getUID ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getUID() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getUID ( unsigned long  idx,
std::string &  parameter 
) const

◆ getUIDTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getUIDTag ( ) const
inline

◆ getValueType() [1/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getValueType ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getValueType() [2/2]

bool ml::DcmDRTContentItemModifierSequenceInterface::getValueType ( unsigned long  idx,
std::string &  parameter 
) const

◆ getValueTypeTag()

std::string ml::DcmDRTContentItemModifierSequenceInterface::getValueTypeTag ( ) const
inline

◆ hasSequence()

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

Check if the DRTContentItemModifierSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 223 of file mlDcmDRTContentItemModifierSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTContentItemModifierSequenceInterface::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 255 of file mlDcmDRTContentItemModifierSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTContentItemModifierSequenceInterface::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 267 of file mlDcmDRTContentItemModifierSequenceInterface.h.

◆ setConceptCodeSequence()

void ml::DcmDRTContentItemModifierSequenceInterface::setConceptCodeSequence ( DcmDRTConceptCodeSequenceInterface  seq,
unsigned long  idx 
)

◆ setConceptNameCodeSequence()

void ml::DcmDRTContentItemModifierSequenceInterface::setConceptNameCodeSequence ( DcmDRTConceptNameCodeSequenceInterface  seq,
unsigned long  idx 
)

◆ setDate()

bool ml::DcmDRTContentItemModifierSequenceInterface::setDate ( unsigned long  idx,
std::string  parameter 
)

◆ setDateTime()

bool ml::DcmDRTContentItemModifierSequenceInterface::setDateTime ( unsigned long  idx,
std::string  parameter 
)

◆ setMeasurementUnitsCodeSequence()

void ml::DcmDRTContentItemModifierSequenceInterface::setMeasurementUnitsCodeSequence ( DcmDRTMeasurementUnitsCodeSequenceInterface  seq,
unsigned long  idx 
)

◆ setNumericValue()

bool ml::DcmDRTContentItemModifierSequenceInterface::setNumericValue ( unsigned long  idx,
std::string  parameter 
)

◆ setPersonName()

bool ml::DcmDRTContentItemModifierSequenceInterface::setPersonName ( unsigned long  idx,
std::string  parameter 
)

◆ setSequence()

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

Set the DRTContentItemModifierSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTContentItemModifierSequence

Definition at line 211 of file mlDcmDRTContentItemModifierSequenceInterface.h.

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

◆ setTextValue()

bool ml::DcmDRTContentItemModifierSequenceInterface::setTextValue ( unsigned long  idx,
std::string  parameter 
)

◆ setTime()

bool ml::DcmDRTContentItemModifierSequenceInterface::setTime ( unsigned long  idx,
std::string  parameter 
)

◆ setUID()

bool ml::DcmDRTContentItemModifierSequenceInterface::setUID ( unsigned long  idx,
std::string  parameter 
)

◆ setValueType()

bool ml::DcmDRTContentItemModifierSequenceInterface::setValueType ( unsigned long  idx,
std::string  parameter 
)

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 279 of file mlDcmDRTContentItemModifierSequenceInterface.h.


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