MeVisLab Toolbox Reference
ml::DcmDRTOtherPatientIDsSequenceInterface Class Reference

Class to provide access to DRTOtherPatientIDsSequence. More...

#include <mlDcmDRTOtherPatientIDsSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTOtherPatientIDsSequenceInterface ()
 DcmDRTOtherPatientIDsSequenceInterface (std::vector< DcmDRTOtherPatientIDsSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTOtherPatientIDsSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTOtherPatientIDsSequenceInterface ()
 Default virtual Destructor.
bool getIssuerOfPatientID (unsigned long idx, std::string &parameter) const
bool getIssuerOfPatientID (DCMTree::TreePtr item, std::string &parameter) const
std::string getIssuerOfPatientIDTag () const
bool setIssuerOfPatientID (unsigned long idx, std::string parameter)
bool getPatientID (unsigned long idx, std::string &parameter) const
bool getPatientID (DCMTree::TreePtr item, std::string &parameter) const
std::string getPatientIDTag () const
bool setPatientID (unsigned long idx, std::string parameter)
bool getTypeOfPatientID (unsigned long idx, std::string &parameter) const
bool getTypeOfPatientID (DCMTree::TreePtr item, std::string &parameter) const
std::string getTypeOfPatientIDTag () const
bool setTypeOfPatientID (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTOtherPatientIDsSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTOtherPatientIDsSequenceInterface::ItemgetSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTOtherPatientIDsSequenceInterface::Item getItem (const size_t idx) const
DcmDRTOtherPatientIDsSequenceInterface::ItemaddItem ()
void addItem (DcmDRTOtherPatientIDsSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

std::vector< DcmDRTOtherPatientIDsSequenceInterface::Item_itemVec
 Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTOtherPatientIDsSequence.

Definition at line 43 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTOtherPatientIDsSequenceInterface() [1/3]

ml::DcmDRTOtherPatientIDsSequenceInterface::DcmDRTOtherPatientIDsSequenceInterface ( )
inline

Definition at line 88 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

◆ DcmDRTOtherPatientIDsSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 91 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ DcmDRTOtherPatientIDsSequenceInterface() [3/3]

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

Definition at line 93 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTOtherPatientIDsSequenceInterface()

virtual ml::DcmDRTOtherPatientIDsSequenceInterface::~DcmDRTOtherPatientIDsSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 101 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTOtherPatientIDsSequenceInterface::Item & ml::DcmDRTOtherPatientIDsSequenceInterface::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 mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 161 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ getIssuerOfPatientID() [1/2]

bool ml::DcmDRTOtherPatientIDsSequenceInterface::getIssuerOfPatientID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getIssuerOfPatientID() [2/2]

bool ml::DcmDRTOtherPatientIDsSequenceInterface::getIssuerOfPatientID ( unsigned long idx,
std::string & parameter ) const

◆ getIssuerOfPatientIDTag()

std::string ml::DcmDRTOtherPatientIDsSequenceInterface::getIssuerOfPatientIDTag ( ) const
inline

Definition at line 105 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

◆ getItem()

DcmDRTOtherPatientIDsSequenceInterface::Item ml::DcmDRTOtherPatientIDsSequenceInterface::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 mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTOtherPatientIDsSequenceInterface::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 mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ getPatientID() [1/2]

bool ml::DcmDRTOtherPatientIDsSequenceInterface::getPatientID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPatientID() [2/2]

bool ml::DcmDRTOtherPatientIDsSequenceInterface::getPatientID ( unsigned long idx,
std::string & parameter ) const

◆ getPatientIDTag()

std::string ml::DcmDRTOtherPatientIDsSequenceInterface::getPatientIDTag ( ) const
inline

Definition at line 111 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

◆ getSequence()

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

Return the DRTOtherPatientIDsSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTOtherPatientIDsSequence

Definition at line 129 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

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

◆ getTypeOfPatientID() [1/2]

bool ml::DcmDRTOtherPatientIDsSequenceInterface::getTypeOfPatientID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getTypeOfPatientID() [2/2]

bool ml::DcmDRTOtherPatientIDsSequenceInterface::getTypeOfPatientID ( unsigned long idx,
std::string & parameter ) const

◆ getTypeOfPatientIDTag()

std::string ml::DcmDRTOtherPatientIDsSequenceInterface::getTypeOfPatientIDTag ( ) const
inline

Definition at line 117 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTOtherPatientIDsSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTOtherPatientIDsSequenceInterface::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 mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTOtherPatientIDsSequenceInterface::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 mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ setIssuerOfPatientID()

bool ml::DcmDRTOtherPatientIDsSequenceInterface::setIssuerOfPatientID ( unsigned long idx,
std::string parameter )

◆ setPatientID()

bool ml::DcmDRTOtherPatientIDsSequenceInterface::setPatientID ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTOtherPatientIDsSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTOtherPatientIDsSequence

Definition at line 123 of file mlDcmDRTOtherPatientIDsSequenceInterface.h.

References _itemVec.

◆ setTypeOfPatientID()

bool ml::DcmDRTOtherPatientIDsSequenceInterface::setTypeOfPatientID ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

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