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

Class to provide access to DRTContributingEquipmentSequence. More...

#include <mlDcmDRTContributingEquipmentSequenceInterface.h>

Classes

class  Item
 

Public Member Functions

 DcmDRTContributingEquipmentSequenceInterface ()
 
 DcmDRTContributingEquipmentSequenceInterface (std::vector< DcmDRTContributingEquipmentSequenceInterface::Item > dcmSequence)
 Default Constructor.
 
 DcmDRTContributingEquipmentSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
 
virtual ~DcmDRTContributingEquipmentSequenceInterface ()
 Default virtual Destructor.
 
bool getContributionDateTime (unsigned long idx, std::string &parameter) const
 
bool getContributionDateTime (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getContributionDateTimeTag () const
 
bool setContributionDateTime (unsigned long idx, std::string parameter)
 
bool getContributionDescription (unsigned long idx, std::string &parameter) const
 
bool getContributionDescription (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getContributionDescriptionTag () const
 
bool setContributionDescription (unsigned long idx, std::string parameter)
 
bool getDateOfLastCalibration (unsigned long idx, std::string &parameter) const
 
bool getDateOfLastCalibration (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDateOfLastCalibrationTag () const
 
bool setDateOfLastCalibration (unsigned long idx, std::string parameter)
 
bool getDeviceSerialNumber (unsigned long idx, std::string &parameter) const
 
bool getDeviceSerialNumber (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getDeviceSerialNumberTag () const
 
bool setDeviceSerialNumber (unsigned long idx, std::string parameter)
 
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 getInstitutionalDepartmentName (unsigned long idx, std::string &parameter) const
 
bool getInstitutionalDepartmentName (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getInstitutionalDepartmentNameTag () const
 
bool setInstitutionalDepartmentName (unsigned long idx, std::string parameter)
 
bool getManufacturer (unsigned long idx, std::string &parameter) const
 
bool getManufacturer (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getManufacturerTag () const
 
bool setManufacturer (unsigned long idx, std::string parameter)
 
bool getManufacturerModelName (unsigned long idx, std::string &parameter) const
 
bool getManufacturerModelName (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getManufacturerModelNameTag () const
 
bool setManufacturerModelName (unsigned long idx, std::string parameter)
 
bool getSoftwareVersions (unsigned long idx, std::string &parameter) const
 
bool getSoftwareVersions (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getSoftwareVersionsTag () const
 
bool setSoftwareVersions (unsigned long idx, std::string parameter)
 
bool getSpatialResolution (unsigned long idx, std::string &parameter) const
 
bool getSpatialResolution (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getSpatialResolutionTag () const
 
bool setSpatialResolution (unsigned long idx, std::string parameter)
 
bool getStationName (unsigned long idx, std::string &parameter) const
 
bool getStationName (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getStationNameTag () const
 
bool setStationName (unsigned long idx, std::string parameter)
 
bool getTimeOfLastCalibration (unsigned long idx, std::string &parameter) const
 
bool getTimeOfLastCalibration (DCMTree::TreePtr item, std::string &parameter) const
 
std::string getTimeOfLastCalibrationTag () const
 
bool setTimeOfLastCalibration (unsigned long idx, std::string parameter)
 
DcmDRTPurposeOfReferenceCodeSequenceInterface getPurposeOfReferenceCodeSequence (unsigned long idx) const
 
std::string getPurposeOfReferenceCodeSequenceTag () const
 
void setPurposeOfReferenceCodeSequence (DcmDRTPurposeOfReferenceCodeSequenceInterface seq, unsigned long idx)
 
void setSequence (std::vector< DcmDRTContributingEquipmentSequenceInterface::Item > dcmSequence)
 Set the DRTContributingEquipmentSequence this interface class provides access to.
 
std::vector< DcmDRTContributingEquipmentSequenceInterface::Item > getSequence () const
 Return the DRTContributingEquipmentSequence this interface class provides access to.
 
bool hasSequence () const
 Check if the DRTContributingEquipmentSequence is set.
 
MLint getNumberOfItems () const
 Return number of items the internal sequence consists of.
 
DcmDRTContributingEquipmentSequenceInterface::Item getItem (const size_t idx) const
 Gets the item at the indicated position.
 
DcmDRTContributingEquipmentSequenceInterface::Item & addItem ()
 Adds a new item to the sequence.
 
void addItem (DcmDRTContributingEquipmentSequenceInterface::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< DcmDRTContributingEquipmentSequenceInterface::Item > _itemVec
 Reference to the wrapped DICOM tree pointer vector.
 

Detailed Description

Class to provide access to DRTContributingEquipmentSequence.

Definition at line 44 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTContributingEquipmentSequenceInterface() [1/3]

ml::DcmDRTContributingEquipmentSequenceInterface::DcmDRTContributingEquipmentSequenceInterface ( )
inline

Definition at line 144 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ DcmDRTContributingEquipmentSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 147 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ DcmDRTContributingEquipmentSequenceInterface() [3/3]

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

Definition at line 149 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ ~DcmDRTContributingEquipmentSequenceInterface()

virtual ml::DcmDRTContributingEquipmentSequenceInterface::~DcmDRTContributingEquipmentSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 157 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence.

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

Definition at line 277 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ addItem() [2/2]

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

Definition at line 282 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ getContributionDateTime() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getContributionDateTime ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getContributionDateTime() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getContributionDateTime ( unsigned long  idx,
std::string &  parameter 
) const

◆ getContributionDateTimeTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getContributionDateTimeTag ( ) const
inline

Definition at line 161 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getContributionDateTimeTag().

◆ getContributionDescription() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getContributionDescription ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getContributionDescription() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getContributionDescription ( unsigned long  idx,
std::string &  parameter 
) const

◆ getContributionDescriptionTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getContributionDescriptionTag ( ) const
inline

Definition at line 167 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getContributionDescriptionTag().

◆ getDateOfLastCalibration() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getDateOfLastCalibration ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDateOfLastCalibration() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getDateOfLastCalibration ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDateOfLastCalibrationTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getDateOfLastCalibrationTag ( ) const
inline

Definition at line 173 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getDateOfLastCalibrationTag().

◆ getDeviceSerialNumber() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getDeviceSerialNumber ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getDeviceSerialNumber() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getDeviceSerialNumber ( unsigned long  idx,
std::string &  parameter 
) const

◆ getDeviceSerialNumberTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getDeviceSerialNumberTag ( ) const
inline

Definition at line 179 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getDeviceSerialNumberTag().

◆ getInstitutionAddress() [1/2]

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

◆ getInstitutionAddress() [2/2]

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

◆ getInstitutionAddressTag()

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

Definition at line 185 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getInstitutionAddressTag().

◆ getInstitutionalDepartmentName() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getInstitutionalDepartmentName ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getInstitutionalDepartmentName() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getInstitutionalDepartmentName ( unsigned long  idx,
std::string &  parameter 
) const

◆ getInstitutionalDepartmentNameTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getInstitutionalDepartmentNameTag ( ) const
inline

Definition at line 197 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getInstitutionalDepartmentNameTag().

◆ getInstitutionName() [1/2]

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

◆ getInstitutionName() [2/2]

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

◆ getInstitutionNameTag()

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

Definition at line 191 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getInstitutionNameTag().

◆ getItem()

DcmDRTContributingEquipmentSequenceInterface::Item ml::DcmDRTContributingEquipmentSequenceInterface::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 268 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ getManufacturer() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getManufacturer ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getManufacturer() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getManufacturer ( unsigned long  idx,
std::string &  parameter 
) const

◆ getManufacturerModelName() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getManufacturerModelName ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getManufacturerModelName() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getManufacturerModelName ( unsigned long  idx,
std::string &  parameter 
) const

◆ getManufacturerModelNameTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getManufacturerModelNameTag ( ) const
inline

Definition at line 209 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getManufacturerModelNameTag().

◆ getManufacturerTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getManufacturerTag ( ) const
inline

Definition at line 203 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getManufacturerTag().

◆ getNumberOfItems()

MLint ml::DcmDRTContributingEquipmentSequenceInterface::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 262 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ getPurposeOfReferenceCodeSequence()

DcmDRTPurposeOfReferenceCodeSequenceInterface ml::DcmDRTContributingEquipmentSequenceInterface::getPurposeOfReferenceCodeSequence ( unsigned long  idx) const

◆ getPurposeOfReferenceCodeSequenceTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getPurposeOfReferenceCodeSequenceTag ( ) const
inline

Definition at line 238 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getPurposeOfReferenceCodeSequenceTag().

◆ getSequence()

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

Return the DRTContributingEquipmentSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTContributingEquipmentSequence

Definition at line 250 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

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

◆ getSoftwareVersions() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getSoftwareVersions ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getSoftwareVersions() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getSoftwareVersions ( unsigned long  idx,
std::string &  parameter 
) const

◆ getSoftwareVersionsTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getSoftwareVersionsTag ( ) const
inline

Definition at line 215 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getSoftwareVersionsTag().

◆ getSpatialResolution() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getSpatialResolution ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getSpatialResolution() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getSpatialResolution ( unsigned long  idx,
std::string &  parameter 
) const

◆ getSpatialResolutionTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getSpatialResolutionTag ( ) const
inline

Definition at line 221 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getSpatialResolutionTag().

◆ getStationName() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getStationName ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getStationName() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getStationName ( unsigned long  idx,
std::string &  parameter 
) const

◆ getStationNameTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getStationNameTag ( ) const
inline

Definition at line 227 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getStationNameTag().

◆ getTimeOfLastCalibration() [1/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getTimeOfLastCalibration ( DCMTree::TreePtr  item,
std::string &  parameter 
) const

◆ getTimeOfLastCalibration() [2/2]

bool ml::DcmDRTContributingEquipmentSequenceInterface::getTimeOfLastCalibration ( unsigned long  idx,
std::string &  parameter 
) const

◆ getTimeOfLastCalibrationTag()

std::string ml::DcmDRTContributingEquipmentSequenceInterface::getTimeOfLastCalibrationTag ( ) const
inline

Definition at line 233 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

Referenced by DRTContributingEquipmentSequenceWrapper::getTimeOfLastCalibrationTag().

◆ hasSequence()

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

Check if the DRTContributingEquipmentSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 256 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ insertItem()

bool ml::DcmDRTContributingEquipmentSequenceInterface::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 288 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ removeItem()

bool ml::DcmDRTContributingEquipmentSequenceInterface::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 300 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

◆ setContributionDateTime()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setContributionDateTime ( unsigned long  idx,
std::string  parameter 
)

◆ setContributionDescription()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setContributionDescription ( unsigned long  idx,
std::string  parameter 
)

◆ setDateOfLastCalibration()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setDateOfLastCalibration ( unsigned long  idx,
std::string  parameter 
)

◆ setDeviceSerialNumber()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setDeviceSerialNumber ( unsigned long  idx,
std::string  parameter 
)

◆ setInstitutionAddress()

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

◆ setInstitutionalDepartmentName()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setInstitutionalDepartmentName ( unsigned long  idx,
std::string  parameter 
)

◆ setInstitutionName()

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

◆ setManufacturer()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setManufacturer ( unsigned long  idx,
std::string  parameter 
)

◆ setManufacturerModelName()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setManufacturerModelName ( unsigned long  idx,
std::string  parameter 
)

◆ setPurposeOfReferenceCodeSequence()

void ml::DcmDRTContributingEquipmentSequenceInterface::setPurposeOfReferenceCodeSequence ( DcmDRTPurposeOfReferenceCodeSequenceInterface  seq,
unsigned long  idx 
)

◆ setSequence()

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

Set the DRTContributingEquipmentSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTContributingEquipmentSequence

Definition at line 244 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

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

◆ setSoftwareVersions()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setSoftwareVersions ( unsigned long  idx,
std::string  parameter 
)

◆ setSpatialResolution()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setSpatialResolution ( unsigned long  idx,
std::string  parameter 
)

◆ setStationName()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setStationName ( unsigned long  idx,
std::string  parameter 
)

◆ setTimeOfLastCalibration()

bool ml::DcmDRTContributingEquipmentSequenceInterface::setTimeOfLastCalibration ( unsigned long  idx,
std::string  parameter 
)

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 312 of file mlDcmDRTContributingEquipmentSequenceInterface.h.

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