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

Class to provide access to DRTProtocolContextSequence. More...

#include <mlDcmDRTProtocolContextSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTProtocolContextSequenceInterface ()
 
 DcmDRTProtocolContextSequenceInterface (std::vector< DcmDRTProtocolContextSequenceInterface::Item > dcmSequence)
 Default Constructor. More...
 
 DcmDRTProtocolContextSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTProtocolContextSequenceInterface ()
 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)
 
DcmDRTContentItemModifierSequenceInterface getContentItemModifierSequence (unsigned long idx) const
 
std::string getContentItemModifierSequenceTag () const
 
void setContentItemModifierSequence (DcmDRTContentItemModifierSequenceInterface 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< DcmDRTProtocolContextSequenceInterface::Item > dcmSequence)
 Set the DRTProtocolContextSequence this interface class provides access to. More...
 
std::vector< DcmDRTProtocolContextSequenceInterface::Item > getSequence () const
 Return the DRTProtocolContextSequence this interface class provides access to. More...
 
bool hasSequence () const
 Check if the DRTProtocolContextSequence is set. More...
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of. More...
 
DcmDRTProtocolContextSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position. More...
 
DcmDRTProtocolContextSequenceInterface::Item & addItem ()
 Adds a new item to the sequence. More...
 
void addItem (DcmDRTProtocolContextSequenceInterface::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< DcmDRTProtocolContextSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector. More...
 

Detailed Description

Class to provide access to DRTProtocolContextSequence.

Definition at line 47 of file mlDcmDRTProtocolContextSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTProtocolContextSequenceInterface() [1/3]

ml::DcmDRTProtocolContextSequenceInterface::DcmDRTProtocolContextSequenceInterface ( )
inline

Definition at line 137 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ DcmDRTProtocolContextSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 140 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ DcmDRTProtocolContextSequenceInterface() [3/3]

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

Definition at line 142 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ ~DcmDRTProtocolContextSequenceInterface()

virtual ml::DcmDRTProtocolContextSequenceInterface::~DcmDRTProtocolContextSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 150 of file mlDcmDRTProtocolContextSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 255 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 260 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ getConceptCodeSequence()

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

◆ getConceptCodeSequenceTag()

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

Definition at line 201 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getConceptCodeSequenceTag().

◆ getConceptNameCodeSequence()

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

◆ getConceptNameCodeSequenceTag()

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

Definition at line 206 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getConceptNameCodeSequenceTag().

◆ getContentItemModifierSequence()

DcmDRTContentItemModifierSequenceInterface ml::DcmDRTProtocolContextSequenceInterface::getContentItemModifierSequence ( unsigned long  idx) const

◆ getContentItemModifierSequenceTag()

std::string ml::DcmDRTProtocolContextSequenceInterface::getContentItemModifierSequenceTag ( ) const
inline

Definition at line 211 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getContentItemModifierSequenceTag().

◆ getDate() [1/2]

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

◆ getDate() [2/2]

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

◆ getDateTag()

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

Definition at line 154 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getDateTag().

◆ getDateTime() [1/2]

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

◆ getDateTime() [2/2]

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

◆ getDateTimeTag()

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

Definition at line 160 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getDateTimeTag().

◆ getItem()

DcmDRTProtocolContextSequenceInterface::Item ml::DcmDRTProtocolContextSequenceInterface::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 246 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ getMeasurementUnitsCodeSequence()

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

◆ getMeasurementUnitsCodeSequenceTag()

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

Definition at line 216 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getMeasurementUnitsCodeSequenceTag().

◆ getNumberOfItems()

MLint ml::DcmDRTProtocolContextSequenceInterface::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 240 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ getNumericValue() [1/2]

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

◆ getNumericValue() [2/2]

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

◆ getNumericValueTag()

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

Definition at line 166 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getNumericValueTag().

◆ getPersonName() [1/2]

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

◆ getPersonName() [2/2]

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

◆ getPersonNameTag()

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

Definition at line 172 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getPersonNameTag().

◆ getSequence()

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

Return the DRTProtocolContextSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTProtocolContextSequence

Definition at line 228 of file mlDcmDRTProtocolContextSequenceInterface.h.

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

◆ getTextValue() [1/2]

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

◆ getTextValue() [2/2]

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

◆ getTextValueTag()

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

Definition at line 178 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getTextValueTag().

◆ getTime() [1/2]

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

◆ getTime() [2/2]

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

◆ getTimeTag()

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

Definition at line 184 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getTimeTag().

◆ getUID() [1/2]

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

◆ getUID() [2/2]

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

◆ getUIDTag()

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

Definition at line 190 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getUIDTag().

◆ getValueType() [1/2]

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

◆ getValueType() [2/2]

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

◆ getValueTypeTag()

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

Definition at line 196 of file mlDcmDRTProtocolContextSequenceInterface.h.

Referenced by DRTProtocolContextSequenceWrapper::getValueTypeTag().

◆ hasSequence()

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

Check if the DRTProtocolContextSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 234 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTProtocolContextSequenceInterface::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 266 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTProtocolContextSequenceInterface::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 278 of file mlDcmDRTProtocolContextSequenceInterface.h.

◆ setConceptCodeSequence()

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

◆ setConceptNameCodeSequence()

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

◆ setContentItemModifierSequence()

void ml::DcmDRTProtocolContextSequenceInterface::setContentItemModifierSequence ( DcmDRTContentItemModifierSequenceInterface  seq,
unsigned long  idx 
)

◆ setDate()

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

◆ setDateTime()

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

◆ setMeasurementUnitsCodeSequence()

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

◆ setNumericValue()

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

◆ setPersonName()

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

◆ setSequence()

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

Set the DRTProtocolContextSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTProtocolContextSequence

Definition at line 222 of file mlDcmDRTProtocolContextSequenceInterface.h.

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

◆ setTextValue()

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

◆ setTime()

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

◆ setUID()

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

◆ setValueType()

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 290 of file mlDcmDRTProtocolContextSequenceInterface.h.

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