MeVisLab Toolbox Reference
ml::DcmDRTPlannedVerificationImageSequenceInterface Class Reference

Class to provide access to DRTPlannedVerificationImageSequence. More...

#include <mlDcmDRTPlannedVerificationImageSequenceInterface.h>

Classes

class  Item

Public Member Functions

 DcmDRTPlannedVerificationImageSequenceInterface ()
 DcmDRTPlannedVerificationImageSequenceInterface (std::vector< DcmDRTPlannedVerificationImageSequenceInterface::Item > dcmSequence)
 Default Constructor.
 DcmDRTPlannedVerificationImageSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual ~DcmDRTPlannedVerificationImageSequenceInterface ()
 Default virtual Destructor.
bool getEndCumulativeMetersetWeight (unsigned long idx, std::string &parameter) const
bool getEndCumulativeMetersetWeight (DCMTree::TreePtr item, std::string &parameter) const
std::string getEndCumulativeMetersetWeightTag () const
bool setEndCumulativeMetersetWeight (unsigned long idx, std::string parameter)
bool getImagingDeviceSpecificAcquisitionParameters (unsigned long idx, std::string &parameter) const
bool getImagingDeviceSpecificAcquisitionParameters (DCMTree::TreePtr item, std::string &parameter) const
std::string getImagingDeviceSpecificAcquisitionParametersTag () const
bool setImagingDeviceSpecificAcquisitionParameters (unsigned long idx, std::string parameter)
bool getMetersetExposure (unsigned long idx, std::string &parameter) const
bool getMetersetExposure (DCMTree::TreePtr item, std::string &parameter) const
std::string getMetersetExposureTag () const
bool setMetersetExposure (unsigned long idx, std::string parameter)
bool getRTImageOrientation (unsigned long idx, std::string &parameter) const
bool getRTImageOrientation (DCMTree::TreePtr item, std::string &parameter) const
std::string getRTImageOrientationTag () const
bool setRTImageOrientation (unsigned long idx, std::string parameter)
bool getRTImagePlane (unsigned long idx, std::string &parameter) const
bool getRTImagePlane (DCMTree::TreePtr item, std::string &parameter) const
std::string getRTImagePlaneTag () const
bool setRTImagePlane (unsigned long idx, std::string parameter)
bool getRTImagePosition (unsigned long idx, std::string &parameter) const
bool getRTImagePosition (DCMTree::TreePtr item, std::string &parameter) const
std::string getRTImagePositionTag () const
bool setRTImagePosition (unsigned long idx, std::string parameter)
bool getRTImageSID (unsigned long idx, std::string &parameter) const
bool getRTImageSID (DCMTree::TreePtr item, std::string &parameter) const
std::string getRTImageSIDTag () const
bool setRTImageSID (unsigned long idx, std::string parameter)
bool getReferencedReferenceImageNumber (unsigned long idx, std::string &parameter) const
bool getReferencedReferenceImageNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string getReferencedReferenceImageNumberTag () const
bool setReferencedReferenceImageNumber (unsigned long idx, std::string parameter)
bool getStartCumulativeMetersetWeight (unsigned long idx, std::string &parameter) const
bool getStartCumulativeMetersetWeight (DCMTree::TreePtr item, std::string &parameter) const
std::string getStartCumulativeMetersetWeightTag () const
bool setStartCumulativeMetersetWeight (unsigned long idx, std::string parameter)
bool getXRayImageReceptorAngle (unsigned long idx, std::string &parameter) const
bool getXRayImageReceptorAngle (DCMTree::TreePtr item, std::string &parameter) const
std::string getXRayImageReceptorAngleTag () const
bool setXRayImageReceptorAngle (unsigned long idx, std::string parameter)
void setSequence (std::vector< DcmDRTPlannedVerificationImageSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTPlannedVerificationImageSequenceInterface::Item > getSequence () const
bool hasSequence () const
MLint getNumberOfItems () const
DcmDRTPlannedVerificationImageSequenceInterface::Item getItem (const size_t idx) const
DcmDRTPlannedVerificationImageSequenceInterface::Item & addItem ()
void addItem (DcmDRTPlannedVerificationImageSequenceInterface::Item newItem)
bool insertItem (const size_t idx)
bool removeItem (const size_t idx)

Protected Attributes

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

Detailed Description

Class to provide access to DRTPlannedVerificationImageSequence.

Definition at line 43 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTPlannedVerificationImageSequenceInterface() [1/3]

ml::DcmDRTPlannedVerificationImageSequenceInterface::DcmDRTPlannedVerificationImageSequenceInterface ( )
inline

Definition at line 123 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ DcmDRTPlannedVerificationImageSequenceInterface() [2/3]

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

Default Constructor.

Definition at line 126 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ DcmDRTPlannedVerificationImageSequenceInterface() [3/3]

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

Definition at line 128 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTPlannedVerificationImageSequenceInterface()

virtual ml::DcmDRTPlannedVerificationImageSequenceInterface::~DcmDRTPlannedVerificationImageSequenceInterface ( )
inlinevirtual

Default virtual Destructor.

Definition at line 136 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

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

Adds a new item to the sequence

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

Definition at line 233 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

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

Definition at line 238 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ getEndCumulativeMetersetWeight() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getEndCumulativeMetersetWeight ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getEndCumulativeMetersetWeight() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getEndCumulativeMetersetWeight ( unsigned long idx,
std::string & parameter ) const

◆ getEndCumulativeMetersetWeightTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getEndCumulativeMetersetWeightTag ( ) const
inline

Definition at line 140 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getImagingDeviceSpecificAcquisitionParameters() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getImagingDeviceSpecificAcquisitionParameters ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getImagingDeviceSpecificAcquisitionParameters() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getImagingDeviceSpecificAcquisitionParameters ( unsigned long idx,
std::string & parameter ) const

◆ getImagingDeviceSpecificAcquisitionParametersTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getImagingDeviceSpecificAcquisitionParametersTag ( ) const
inline

Definition at line 146 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getItem()

DcmDRTPlannedVerificationImageSequenceInterface::Item ml::DcmDRTPlannedVerificationImageSequenceInterface::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 224 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ getMetersetExposure() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getMetersetExposure ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getMetersetExposure() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getMetersetExposure ( unsigned long idx,
std::string & parameter ) const

◆ getMetersetExposureTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getMetersetExposureTag ( ) const
inline

Definition at line 152 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getNumberOfItems()

MLint ml::DcmDRTPlannedVerificationImageSequenceInterface::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 218 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ getReferencedReferenceImageNumber() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getReferencedReferenceImageNumber ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getReferencedReferenceImageNumber() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getReferencedReferenceImageNumber ( unsigned long idx,
std::string & parameter ) const

◆ getReferencedReferenceImageNumberTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getReferencedReferenceImageNumberTag ( ) const
inline

Definition at line 182 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getRTImageOrientation() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImageOrientation ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRTImageOrientation() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImageOrientation ( unsigned long idx,
std::string & parameter ) const

◆ getRTImageOrientationTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImageOrientationTag ( ) const
inline

Definition at line 158 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getRTImagePlane() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImagePlane ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRTImagePlane() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImagePlane ( unsigned long idx,
std::string & parameter ) const

◆ getRTImagePlaneTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImagePlaneTag ( ) const
inline

Definition at line 164 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getRTImagePosition() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImagePosition ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRTImagePosition() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImagePosition ( unsigned long idx,
std::string & parameter ) const

◆ getRTImagePositionTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImagePositionTag ( ) const
inline

Definition at line 170 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getRTImageSID() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImageSID ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getRTImageSID() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImageSID ( unsigned long idx,
std::string & parameter ) const

◆ getRTImageSIDTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getRTImageSIDTag ( ) const
inline

Definition at line 176 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getSequence()

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

Return the DRTPlannedVerificationImageSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTPlannedVerificationImageSequence

Definition at line 206 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

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

◆ getStartCumulativeMetersetWeight() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getStartCumulativeMetersetWeight ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getStartCumulativeMetersetWeight() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getStartCumulativeMetersetWeight ( unsigned long idx,
std::string & parameter ) const

◆ getStartCumulativeMetersetWeightTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getStartCumulativeMetersetWeightTag ( ) const
inline

Definition at line 188 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ getXRayImageReceptorAngle() [1/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getXRayImageReceptorAngle ( DCMTree::TreePtr item,
std::string & parameter ) const

◆ getXRayImageReceptorAngle() [2/2]

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::getXRayImageReceptorAngle ( unsigned long idx,
std::string & parameter ) const

◆ getXRayImageReceptorAngleTag()

std::string ml::DcmDRTPlannedVerificationImageSequenceInterface::getXRayImageReceptorAngleTag ( ) const
inline

Definition at line 194 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

◆ hasSequence()

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

Check if the DRTPlannedVerificationImageSequence is set.

Returns
True if internal pointer is set, False else.

Definition at line 212 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::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 244 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::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 256 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ setEndCumulativeMetersetWeight()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setEndCumulativeMetersetWeight ( unsigned long idx,
std::string parameter )

◆ setImagingDeviceSpecificAcquisitionParameters()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setImagingDeviceSpecificAcquisitionParameters ( unsigned long idx,
std::string parameter )

◆ setMetersetExposure()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setMetersetExposure ( unsigned long idx,
std::string parameter )

◆ setReferencedReferenceImageNumber()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setReferencedReferenceImageNumber ( unsigned long idx,
std::string parameter )

◆ setRTImageOrientation()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setRTImageOrientation ( unsigned long idx,
std::string parameter )

◆ setRTImagePlane()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setRTImagePlane ( unsigned long idx,
std::string parameter )

◆ setRTImagePosition()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setRTImagePosition ( unsigned long idx,
std::string parameter )

◆ setRTImageSID()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setRTImageSID ( unsigned long idx,
std::string parameter )

◆ setSequence()

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

Set the DRTPlannedVerificationImageSequence this interface class provides access to.

Parameters
dcmSequencePointer to DRTPlannedVerificationImageSequence

Definition at line 200 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

References _itemVec.

◆ setStartCumulativeMetersetWeight()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setStartCumulativeMetersetWeight ( unsigned long idx,
std::string parameter )

◆ setXRayImageReceptorAngle()

bool ml::DcmDRTPlannedVerificationImageSequenceInterface::setXRayImageReceptorAngle ( unsigned long idx,
std::string parameter )

Member Data Documentation

◆ _itemVec

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

Reference to the wrapped DICOM tree pointer vector.

Definition at line 268 of file mlDcmDRTPlannedVerificationImageSequenceInterface.h.

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

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