MeVisLab Toolbox Reference
ml::DcmDRTRequestAttributesSequenceInterface Class Reference

Class to provide access to DRTRequestAttributesSequence. More...

#include <mlDcmDRTRequestAttributesSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTRequestAttributesSequenceInterface ()
 DcmDRTRequestAttributesSequenceInterface (std::vector< DcmDRTRequestAttributesSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTRequestAttributesSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTRequestAttributesSequenceInterface ()
 Default virtual Destructor.
bool getAccessionNumber (unsigned long idx, std::string &parameter) const
bool getAccessionNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getAccessionNumberTag () const
bool setAccessionNumber (unsigned long idx, std::string parameter)
bool getReasonForTheRequestedProcedure (unsigned long idx, std::string &parameter) const
bool getReasonForTheRequestedProcedure (DCMTree::TreePtr item, std::string &parameter) const
std::string getReasonForTheRequestedProcedureTag () const
bool setReasonForTheRequestedProcedure (unsigned long idx, std::string parameter)
bool getRequestedProcedureDescription (unsigned long idx, std::string &parameter) const
bool getRequestedProcedureDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string getRequestedProcedureDescriptionTag () const
bool setRequestedProcedureDescription (unsigned long idx, std::string parameter)
bool getRequestedProcedureID (unsigned long idx, std::string &parameter) const
bool getRequestedProcedureID (DCMTree::TreePtr item, std::string &parameter) const
std::string getRequestedProcedureIDTag () const
bool setRequestedProcedureID (unsigned long idx, std::string parameter)
bool getScheduledProcedureStepDescription (unsigned long idx, std::string &parameter) const
bool getScheduledProcedureStepDescription (DCMTree::TreePtr item, std::string &parameter) const
std::string getScheduledProcedureStepDescriptionTag () const
bool setScheduledProcedureStepDescription (unsigned long idx, std::string parameter)
bool getScheduledProcedureStepID (unsigned long idx, std::string &parameter) const
bool getScheduledProcedureStepID (DCMTree::TreePtr item, std::string &parameter) const
std::string getScheduledProcedureStepIDTag () const
bool setScheduledProcedureStepID (unsigned long idx, std::string parameter)
bool getStudyInstanceUID (unsigned long idx, std::string &parameter) const
bool getStudyInstanceUID (DCMTree::TreePtr item, std::string &parameter) const
std::string getStudyInstanceUIDTag () const
bool setStudyInstanceUID (unsigned long idx, std::string parameter)
DcmDRTReasonForRequestedProcedureCodeSequenceInterface getReasonForRequestedProcedureCodeSequence (unsigned long idx) const
std::string getReasonForRequestedProcedureCodeSequenceTag () const
void setReasonForRequestedProcedureCodeSequence (DcmDRTReasonForRequestedProcedureCodeSequenceInterface seq, unsigned long idx)
DcmDRTReferencedStudySequenceInterface getReferencedStudySequence (unsigned long idx) const
std::string getReferencedStudySequenceTag () const
void setReferencedStudySequence (DcmDRTReferencedStudySequenceInterface seq, unsigned long idx)
DcmDRTRequestedProcedureCodeSequenceInterface getRequestedProcedureCodeSequence (unsigned long idx) const
std::string getRequestedProcedureCodeSequenceTag () const
void setRequestedProcedureCodeSequence (DcmDRTRequestedProcedureCodeSequenceInterface seq, unsigned long idx)
DcmDRTScheduledProtocolCodeSequenceInterface getScheduledProtocolCodeSequence (unsigned long idx) const
std::string getScheduledProtocolCodeSequenceTag () const
void setScheduledProtocolCodeSequence (DcmDRTScheduledProtocolCodeSequenceInterface seq, unsigned long idx)
void setSequence (std::vector< DcmDRTRequestAttributesSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTRequestAttributesSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTRequestAttributesSequenceInterface::Item getItem (const size_t idx) const
DcmDRTRequestAttributesSequenceInterface::Item & addItem ()
void addItem (DcmDRTRequestAttributesSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

std::vector< DcmDRTRequestAttributesSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTRequestAttributesSequence.

Definition at line 47 of file mlDcmDRTRequestAttributesSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRequestAttributesSequenceInterface() [1/3]

ml::DcmDRTRequestAttributesSequenceInterface::DcmDRTRequestAttributesSequenceInterface ( )
inline

Definition at line 132 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ DcmDRTRequestAttributesSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 135 of file mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ DcmDRTRequestAttributesSequenceInterface() [3/3]

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

Definition at line 137 of file mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTRequestAttributesSequenceInterface()

virtual ml::DcmDRTRequestAttributesSequenceInterface::~DcmDRTRequestAttributesSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 145 of file mlDcmDRTRequestAttributesSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTRequestAttributesSequenceInterface::Item & ml::DcmDRTRequestAttributesSequenceInterface::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 mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 249 of file mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ getAccessionNumber() [1/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getAccessionNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getAccessionNumber() [2/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getAccessionNumber ( unsigned long idx,
std::string & parameter ) const

◆ getAccessionNumberTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getAccessionNumberTag ( ) const
inline

Definition at line 149 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getItem()

DcmDRTRequestAttributesSequenceInterface::Item ml::DcmDRTRequestAttributesSequenceInterface::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 mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTRequestAttributesSequenceInterface::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 mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ getReasonForRequestedProcedureCodeSequence()

DcmDRTReasonForRequestedProcedureCodeSequenceInterface ml::DcmDRTRequestAttributesSequenceInterface::getReasonForRequestedProcedureCodeSequence ( unsigned long idx) const

◆ getReasonForRequestedProcedureCodeSequenceTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getReasonForRequestedProcedureCodeSequenceTag ( ) const
inline

Definition at line 190 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getReasonForTheRequestedProcedure() [1/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getReasonForTheRequestedProcedure ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReasonForTheRequestedProcedure() [2/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getReasonForTheRequestedProcedure ( unsigned long idx,
std::string & parameter ) const

◆ getReasonForTheRequestedProcedureTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getReasonForTheRequestedProcedureTag ( ) const
inline

Definition at line 155 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getReferencedStudySequence()

DcmDRTReferencedStudySequenceInterface ml::DcmDRTRequestAttributesSequenceInterface::getReferencedStudySequence ( unsigned long idx) const

◆ getReferencedStudySequenceTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getReferencedStudySequenceTag ( ) const
inline

Definition at line 195 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getRequestedProcedureCodeSequence()

DcmDRTRequestedProcedureCodeSequenceInterface ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureCodeSequence ( unsigned long idx) const

◆ getRequestedProcedureCodeSequenceTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureCodeSequenceTag ( ) const
inline

Definition at line 200 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getRequestedProcedureDescription() [1/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureDescription ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRequestedProcedureDescription() [2/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureDescription ( unsigned long idx,
std::string & parameter ) const

◆ getRequestedProcedureDescriptionTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureDescriptionTag ( ) const
inline

Definition at line 161 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getRequestedProcedureID() [1/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRequestedProcedureID() [2/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureID ( unsigned long idx,
std::string & parameter ) const

◆ getRequestedProcedureIDTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getRequestedProcedureIDTag ( ) const
inline

Definition at line 167 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getScheduledProcedureStepDescription() [1/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProcedureStepDescription ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getScheduledProcedureStepDescription() [2/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProcedureStepDescription ( unsigned long idx,
std::string & parameter ) const

◆ getScheduledProcedureStepDescriptionTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProcedureStepDescriptionTag ( ) const
inline

Definition at line 173 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getScheduledProcedureStepID() [1/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProcedureStepID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getScheduledProcedureStepID() [2/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProcedureStepID ( unsigned long idx,
std::string & parameter ) const

◆ getScheduledProcedureStepIDTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProcedureStepIDTag ( ) const
inline

Definition at line 179 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getScheduledProtocolCodeSequence()

DcmDRTScheduledProtocolCodeSequenceInterface ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProtocolCodeSequence ( unsigned long idx) const

◆ getScheduledProtocolCodeSequenceTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getScheduledProtocolCodeSequenceTag ( ) const
inline

Definition at line 205 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ getSequence()

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

Return the DRTRequestAttributesSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRequestAttributesSequence

Definition at line 217 of file mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

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

◆ getStudyInstanceUID() [1/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getStudyInstanceUID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getStudyInstanceUID() [2/2]

bool ml::DcmDRTRequestAttributesSequenceInterface::getStudyInstanceUID ( unsigned long idx,
std::string & parameter ) const

◆ getStudyInstanceUIDTag()

std::string ml::DcmDRTRequestAttributesSequenceInterface::getStudyInstanceUIDTag ( ) const
inline

Definition at line 185 of file mlDcmDRTRequestAttributesSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTRequestAttributesSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 223 of file mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTRequestAttributesSequenceInterface::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 mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTRequestAttributesSequenceInterface::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 mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ setAccessionNumber()

bool ml::DcmDRTRequestAttributesSequenceInterface::setAccessionNumber ( unsigned long idx,
std::string parameter )

◆ setReasonForRequestedProcedureCodeSequence()

void ml::DcmDRTRequestAttributesSequenceInterface::setReasonForRequestedProcedureCodeSequence ( DcmDRTReasonForRequestedProcedureCodeSequenceInterface seq,
unsigned long idx )

◆ setReasonForTheRequestedProcedure()

bool ml::DcmDRTRequestAttributesSequenceInterface::setReasonForTheRequestedProcedure ( unsigned long idx,
std::string parameter )

◆ setReferencedStudySequence()

void ml::DcmDRTRequestAttributesSequenceInterface::setReferencedStudySequence ( DcmDRTReferencedStudySequenceInterface seq,
unsigned long idx )

◆ setRequestedProcedureCodeSequence()

void ml::DcmDRTRequestAttributesSequenceInterface::setRequestedProcedureCodeSequence ( DcmDRTRequestedProcedureCodeSequenceInterface seq,
unsigned long idx )

◆ setRequestedProcedureDescription()

bool ml::DcmDRTRequestAttributesSequenceInterface::setRequestedProcedureDescription ( unsigned long idx,
std::string parameter )

◆ setRequestedProcedureID()

bool ml::DcmDRTRequestAttributesSequenceInterface::setRequestedProcedureID ( unsigned long idx,
std::string parameter )

◆ setScheduledProcedureStepDescription()

bool ml::DcmDRTRequestAttributesSequenceInterface::setScheduledProcedureStepDescription ( unsigned long idx,
std::string parameter )

◆ setScheduledProcedureStepID()

bool ml::DcmDRTRequestAttributesSequenceInterface::setScheduledProcedureStepID ( unsigned long idx,
std::string parameter )

◆ setScheduledProtocolCodeSequence()

void ml::DcmDRTRequestAttributesSequenceInterface::setScheduledProtocolCodeSequence ( DcmDRTScheduledProtocolCodeSequenceInterface seq,
unsigned long idx )

◆ setSequence()

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

Set the DRTRequestAttributesSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTRequestAttributesSequence

Definition at line 211 of file mlDcmDRTRequestAttributesSequenceInterface.h.

References _itemVec.

◆ setStudyInstanceUID()

bool ml::DcmDRTRequestAttributesSequenceInterface::setStudyInstanceUID ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 279 of file mlDcmDRTRequestAttributesSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTRequestAttributesSequenceInterface(), DcmDRTRequestAttributesSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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