DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes
DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule::Item:

List of all members.

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor
 Item (const Item &copy)
 copy constructor
virtual ~Item ()
 destructor
Itemoperator= (const Item &copy)
 assigment operator
void clear ()
 clear all internal member variables
OFBool isEmpty ()
 check if item is empty
OFBool isValid () const
 check if item is valid, i.e. not the empty default item
OFCondition read (DcmItem &item)
 read elements from sequence item
OFCondition write (DcmItem &item)
 write elements to sequence item
OFCondition getConstraintWeight (OFString &value, const signed long pos=0) const
 get ConstraintWeight (300a,0021)
OFCondition getConstraintWeight (Float64 &value, const unsigned long pos=0) const
 get ConstraintWeight (300a,0021)
OFCondition getDeliveryMaximumDose (OFString &value, const signed long pos=0) const
 get DeliveryMaximumDose (300a,0023)
OFCondition getDeliveryMaximumDose (Float64 &value, const unsigned long pos=0) const
 get DeliveryMaximumDose (300a,0023)
OFCondition getDeliveryWarningDose (OFString &value, const signed long pos=0) const
 get DeliveryWarningDose (300a,0022)
OFCondition getDeliveryWarningDose (Float64 &value, const unsigned long pos=0) const
 get DeliveryWarningDose (300a,0022)
OFCondition getOrganAtRiskFullVolumeDose (OFString &value, const signed long pos=0) const
 get OrganAtRiskFullVolumeDose (300a,002a)
OFCondition getOrganAtRiskFullVolumeDose (Float64 &value, const unsigned long pos=0) const
 get OrganAtRiskFullVolumeDose (300a,002a)
OFCondition getOrganAtRiskLimitDose (OFString &value, const signed long pos=0) const
 get OrganAtRiskLimitDose (300a,002b)
OFCondition getOrganAtRiskLimitDose (Float64 &value, const unsigned long pos=0) const
 get OrganAtRiskLimitDose (300a,002b)
OFCondition getOrganAtRiskMaximumDose (OFString &value, const signed long pos=0) const
 get OrganAtRiskMaximumDose (300a,002c)
OFCondition getOrganAtRiskMaximumDose (Float64 &value, const unsigned long pos=0) const
 get OrganAtRiskMaximumDose (300a,002c)
OFCondition getOrganAtRiskOverdoseVolumeFraction (OFString &value, const signed long pos=0) const
 get OrganAtRiskOverdoseVolumeFraction (300a,002d)
OFCondition getOrganAtRiskOverdoseVolumeFraction (Float64 &value, const unsigned long pos=0) const
 get OrganAtRiskOverdoseVolumeFraction (300a,002d)
OFCondition getReferencedDoseReferenceNumber (OFString &value, const signed long pos=0) const
 get ReferencedDoseReferenceNumber (300c,0051)
OFCondition getReferencedDoseReferenceNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedDoseReferenceNumber (300c,0051)
OFCondition getTargetMaximumDose (OFString &value, const signed long pos=0) const
 get TargetMaximumDose (300a,0027)
OFCondition getTargetMaximumDose (Float64 &value, const unsigned long pos=0) const
 get TargetMaximumDose (300a,0027)
OFCondition getTargetMinimumDose (OFString &value, const signed long pos=0) const
 get TargetMinimumDose (300a,0025)
OFCondition getTargetMinimumDose (Float64 &value, const unsigned long pos=0) const
 get TargetMinimumDose (300a,0025)
OFCondition getTargetPrescriptionDose (OFString &value, const signed long pos=0) const
 get TargetPrescriptionDose (300a,0026)
OFCondition getTargetPrescriptionDose (Float64 &value, const unsigned long pos=0) const
 get TargetPrescriptionDose (300a,0026)
OFCondition getTargetUnderdoseVolumeFraction (OFString &value, const signed long pos=0) const
 get TargetUnderdoseVolumeFraction (300a,0028)
OFCondition getTargetUnderdoseVolumeFraction (Float64 &value, const unsigned long pos=0) const
 get TargetUnderdoseVolumeFraction (300a,0028)
OFCondition setConstraintWeight (const OFString &value, const OFBool check=OFTrue)
 set ConstraintWeight (300a,0021)
OFCondition setDeliveryMaximumDose (const OFString &value, const OFBool check=OFTrue)
 set DeliveryMaximumDose (300a,0023)
OFCondition setDeliveryWarningDose (const OFString &value, const OFBool check=OFTrue)
 set DeliveryWarningDose (300a,0022)
OFCondition setOrganAtRiskFullVolumeDose (const OFString &value, const OFBool check=OFTrue)
 set OrganAtRiskFullVolumeDose (300a,002a)
OFCondition setOrganAtRiskLimitDose (const OFString &value, const OFBool check=OFTrue)
 set OrganAtRiskLimitDose (300a,002b)
OFCondition setOrganAtRiskMaximumDose (const OFString &value, const OFBool check=OFTrue)
 set OrganAtRiskMaximumDose (300a,002c)
OFCondition setOrganAtRiskOverdoseVolumeFraction (const OFString &value, const OFBool check=OFTrue)
 set OrganAtRiskOverdoseVolumeFraction (300a,002d)
OFCondition setReferencedDoseReferenceNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedDoseReferenceNumber (300c,0051)
OFCondition setTargetMaximumDose (const OFString &value, const OFBool check=OFTrue)
 set TargetMaximumDose (300a,0027)
OFCondition setTargetMinimumDose (const OFString &value, const OFBool check=OFTrue)
 set TargetMinimumDose (300a,0025)
OFCondition setTargetPrescriptionDose (const OFString &value, const OFBool check=OFTrue)
 set TargetPrescriptionDose (300a,0026)
OFCondition setTargetUnderdoseVolumeFraction (const OFString &value, const OFBool check=OFTrue)
 set TargetUnderdoseVolumeFraction (300a,0028)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmDecimalString ConstraintWeight
 ConstraintWeight (300a,0021) vr=DS, vm=1, type=3.
DcmDecimalString DeliveryMaximumDose
 DeliveryMaximumDose (300a,0023) vr=DS, vm=1, type=3.
DcmDecimalString DeliveryWarningDose
 DeliveryWarningDose (300a,0022) vr=DS, vm=1, type=3.
DcmDecimalString OrganAtRiskFullVolumeDose
 OrganAtRiskFullVolumeDose (300a,002a) vr=DS, vm=1, type=3.
DcmDecimalString OrganAtRiskLimitDose
 OrganAtRiskLimitDose (300a,002b) vr=DS, vm=1, type=3.
DcmDecimalString OrganAtRiskMaximumDose
 OrganAtRiskMaximumDose (300a,002c) vr=DS, vm=1, type=3.
DcmDecimalString OrganAtRiskOverdoseVolumeFraction
 OrganAtRiskOverdoseVolumeFraction (300a,002d) vr=DS, vm=1, type=3.
DcmIntegerString ReferencedDoseReferenceNumber
 ReferencedDoseReferenceNumber (300c,0051) vr=IS, vm=1, type=1C.
DcmDecimalString TargetMaximumDose
 TargetMaximumDose (300a,0027) vr=DS, vm=1, type=3.
DcmDecimalString TargetMinimumDose
 TargetMinimumDose (300a,0025) vr=DS, vm=1, type=3.
DcmDecimalString TargetPrescriptionDose
 TargetPrescriptionDose (300a,0026) vr=DS, vm=1, type=3.
DcmDecimalString TargetUnderdoseVolumeFraction
 TargetUnderdoseVolumeFraction (300a,0028) vr=DS, vm=1, type=3.

Detailed Description

Item class.


Constructor & Destructor Documentation

DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule::Item::Item ( const OFBool  emptyDefaultItem = OFFalse)

(default) constructor

Parameters:
emptyDefaultItemflag used to mark the empty default item

copy constructor

Parameters:
copyitem object to be copied

Member Function Documentation

get ConstraintWeight (300a,0021)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule::Item::getConstraintWeight ( Float64 &  value,
const unsigned long  pos = 0 
) const

get ConstraintWeight (300a,0021)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get DeliveryMaximumDose (300a,0023)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get DeliveryMaximumDose (300a,0023)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get DeliveryWarningDose (300a,0022)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get DeliveryWarningDose (300a,0022)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskFullVolumeDose (300a,002a)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskFullVolumeDose (300a,002a)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskLimitDose (300a,002b)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskLimitDose (300a,002b)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskMaximumDose (300a,002c)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskMaximumDose (300a,002c)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskOverdoseVolumeFraction (300a,002d)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get OrganAtRiskOverdoseVolumeFraction (300a,002d)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get ReferencedDoseReferenceNumber (300c,0051)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get ReferencedDoseReferenceNumber (300c,0051)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetMaximumDose (300a,0027)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetMaximumDose (300a,0027)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetMinimumDose (300a,0025)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetMinimumDose (300a,0025)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetPrescriptionDose (300a,0026)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetPrescriptionDose (300a,0026)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetUnderdoseVolumeFraction (300a,0028)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns:
status, EC_Normal if successful, an error code otherwise

get TargetUnderdoseVolumeFraction (300a,0028)

Parameters:
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns:
status, EC_Normal if successful, an error code otherwise

check if item is empty

Returns:
OFTrue if item is empty, OFFalse otherwise

check if item is valid, i.e. not the empty default item

Returns:
OFTrue if item is valid, OFFalse otherwise
Item& DRTReferencedDoseReferenceSequenceInRTFractionSchemeModule::Item::operator= ( const Item copy)

assigment operator

Parameters:
copyitem object to be copied

read elements from sequence item

Parameters:
itemreference to DICOM sequence item from which the elements should be read
Returns:
status, EC_Normal if successful, an error code otherwise

set ConstraintWeight (300a,0021)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set DeliveryMaximumDose (300a,0023)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set DeliveryWarningDose (300a,0022)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set OrganAtRiskFullVolumeDose (300a,002a)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set OrganAtRiskLimitDose (300a,002b)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set OrganAtRiskMaximumDose (300a,002c)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set OrganAtRiskOverdoseVolumeFraction (300a,002d)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set ReferencedDoseReferenceNumber (300c,0051)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (IS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set TargetMaximumDose (300a,0027)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set TargetMinimumDose (300a,0025)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set TargetPrescriptionDose (300a,0026)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

set TargetUnderdoseVolumeFraction (300a,0028)

Parameters:
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns:
status, EC_Normal if successful, an error code otherwise

write elements to sequence item

Parameters:
itemreference to DICOM sequence item to which the elements should be written
Returns:
status, EC_Normal if successful, an error code otherwise

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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027