MeVisLab Toolbox Reference
ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface Class Reference

Class to provide access to DRTPhysiciansReadingStudyIdentificationSequence. More...

#include <mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface ()
 
 DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface (std::vector< DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item > dcmSequence)
 Default Constructor.
 
 DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface ()
 Default virtual Destructor.
 
bool getInstitutionAddress (unsigned long idx, std::string &parameter) const
 
bool getInstitutionAddress (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getInstitutionAddressTag () const
 
bool setInstitutionAddress (unsigned long idx, std::string parameter)
 
bool getInstitutionName (unsigned long idx, std::string &parameter) const
 
bool getInstitutionName (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getInstitutionNameTag () const
 
bool setInstitutionName (unsigned long idx, std::string parameter)
 
bool getPersonAddress (unsigned long idx, std::string &parameter) const
 
bool getPersonAddress (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getPersonAddressTag () const
 
bool setPersonAddress (unsigned long idx, std::string parameter)
 
bool getPersonTelephoneNumbers (unsigned long idx, std::string &parameter) const
 
bool getPersonTelephoneNumbers (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getPersonTelephoneNumbersTag () const
 
bool setPersonTelephoneNumbers (unsigned long idx, std::string parameter)
 
DcmDRTInstitutionCodeSequenceInterface getInstitutionCodeSequence (unsigned long idx) const
 
std::string getInstitutionCodeSequenceTag () const
 
void setInstitutionCodeSequence (DcmDRTInstitutionCodeSequenceInterface seq, unsigned long idx)
 
DcmDRTPersonIdentificationCodeSequenceInterface getPersonIdentificationCodeSequence (unsigned long idx) const
 
std::string getPersonIdentificationCodeSequenceTag () const
 
void setPersonIdentificationCodeSequence (DcmDRTPersonIdentificationCodeSequenceInterface seq, unsigned long idx)
 
void setSequence (std::vector< DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item > dcmSequence)
 Set the DRTPhysiciansReadingStudyIdentificationSequence this interface class provides access to.
 
std::vector< DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::ItemgetSequence () const
 Return the DRTPhysiciansReadingStudyIdentificationSequence this interface class provides access to.
 
bool hasSequence () const
 Check if the DRTPhysiciansReadingStudyIdentificationSequence is set.
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
 
DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position.
 
DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::ItemaddItem ()
 Adds a new item to the sequence.
 
void addItem (DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item newItem)
 
bool insertItem (const size_t idx)
 Insert an item at the indicated position.
 
bool removeItem (const size_t idx)
 Removes the indicated item from the sequence.
 

Protected Attributes

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

Detailed Description

Class to provide access to DRTPhysiciansReadingStudyIdentificationSequence.

Definition at line 45 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface() [1/3]

ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface ( )
inline

◆ DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 108 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

◆ DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface() [3/3]

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

◆ ~DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface()

virtual ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::~DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 118 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 189 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

◆ addItem() [2/2]

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

◆ getInstitutionAddress() [1/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionAddress ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionAddress() [2/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionAddress ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionAddressTag()

std::string ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionAddressTag ( ) const
inline

◆ getInstitutionCodeSequence()

DcmDRTInstitutionCodeSequenceInterface ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionCodeSequence ( unsigned long idx) const

◆ getInstitutionCodeSequenceTag()

std::string ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionCodeSequenceTag ( ) const
inline

◆ getInstitutionName() [1/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionName ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getInstitutionName() [2/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionName ( unsigned long idx,
std::string & parameter ) const

◆ getInstitutionNameTag()

std::string ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getInstitutionNameTag ( ) const
inline

◆ getItem()

DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::Item ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::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 180 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

References mlrange_cast().

◆ getNumberOfItems()

MLint ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::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 174 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

◆ getPersonAddress() [1/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonAddress ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPersonAddress() [2/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonAddress ( unsigned long idx,
std::string & parameter ) const

◆ getPersonAddressTag()

std::string ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonAddressTag ( ) const
inline

◆ getPersonIdentificationCodeSequence()

DcmDRTPersonIdentificationCodeSequenceInterface ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonIdentificationCodeSequence ( unsigned long idx) const

◆ getPersonIdentificationCodeSequenceTag()

std::string ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonIdentificationCodeSequenceTag ( ) const
inline

◆ getPersonTelephoneNumbers() [1/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonTelephoneNumbers ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getPersonTelephoneNumbers() [2/2]

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonTelephoneNumbers ( unsigned long idx,
std::string & parameter ) const

◆ getPersonTelephoneNumbersTag()

std::string ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::getPersonTelephoneNumbersTag ( ) const
inline

◆ getSequence()

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

Return the DRTPhysiciansReadingStudyIdentificationSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTPhysiciansReadingStudyIdentificationSequence

Definition at line 162 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

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

◆ hasSequence()

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

Check if the DRTPhysiciansReadingStudyIdentificationSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 168 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::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 200 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

References mlrange_cast().

◆ removeItem()

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::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 212 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

References mlrange_cast().

◆ setInstitutionAddress()

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::setInstitutionAddress ( unsigned long idx,
std::string parameter )

◆ setInstitutionCodeSequence()

void ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::setInstitutionCodeSequence ( DcmDRTInstitutionCodeSequenceInterface seq,
unsigned long idx )

◆ setInstitutionName()

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::setInstitutionName ( unsigned long idx,
std::string parameter )

◆ setPersonAddress()

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::setPersonAddress ( unsigned long idx,
std::string parameter )

◆ setPersonIdentificationCodeSequence()

void ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::setPersonIdentificationCodeSequence ( DcmDRTPersonIdentificationCodeSequenceInterface seq,
unsigned long idx )

◆ setPersonTelephoneNumbers()

bool ml::DcmDRTPhysiciansReadingStudyIdentificationSequenceInterface::setPersonTelephoneNumbers ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTPhysiciansReadingStudyIdentificationSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTPhysiciansReadingStudyIdentificationSequence

Definition at line 156 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.

References mlrange_cast().

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

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 224 of file mlDcmDRTPhysiciansReadingStudyIdentificationSequenceInterface.h.


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