DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item:

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor More...
 
 Item (const Item &copy)
 copy constructor More...
 
virtual ~Item ()
 destructor
 
Itemoperator= (const Item &copy)
 assigment operator More...
 
void clear ()
 clear all internal member variables
 
OFBool isEmpty ()
 check if item is empty More...
 
OFBool isValid () const
 check if item is valid, i.e. not the empty default item More...
 
OFCondition read (DcmItem &item)
 read elements from sequence item More...
 
OFCondition write (DcmItem &item)
 write elements to sequence item More...
 
OFCondition getAlternateBeamDose (OFString &value, const signed long pos=0) const
 get AlternateBeamDose (300a,0091) More...
 
OFCondition getAlternateBeamDose (Float64 &value, const unsigned long pos=0) const
 get AlternateBeamDose (300a,0091) More...
 
OFCondition getAlternateBeamDoseType (OFString &value, const signed long pos=0) const
 get AlternateBeamDoseType (300a,0092) More...
 
OFCondition getBeamDeliveryDurationLimit (Float64 &value, const unsigned long pos=0) const
 get BeamDeliveryDurationLimit (300a,00c5) More...
 
OFCondition getBeamDose (OFString &value, const signed long pos=0) const
 get BeamDose (300a,0084) More...
 
OFCondition getBeamDose (Float64 &value, const unsigned long pos=0) const
 get BeamDose (300a,0084) More...
 
OFCondition getBeamDoseSpecificationPoint (OFString &value, const signed long pos=0) const
 get BeamDoseSpecificationPoint (300a,0082) More...
 
OFCondition getBeamDoseSpecificationPoint (Float64 &value, const unsigned long pos=0) const
 get BeamDoseSpecificationPoint (300a,0082) More...
 
OFCondition getBeamDoseSpecificationPoint (OFVector< Float64 > &value) const
 get BeamDoseSpecificationPoint (300a,0082) More...
 
OFCondition getBeamDoseType (OFString &value, const signed long pos=0) const
 get BeamDoseType (300a,0090) More...
 
OFCondition getBeamMeterset (OFString &value, const signed long pos=0) const
 get BeamMeterset (300a,0086) More...
 
OFCondition getBeamMeterset (Float64 &value, const unsigned long pos=0) const
 get BeamMeterset (300a,0086) More...
 
OFCondition getReferencedBeamNumber (OFString &value, const signed long pos=0) const
 get ReferencedBeamNumber (300c,0006) More...
 
OFCondition getReferencedBeamNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedBeamNumber (300c,0006) More...
 
DRTBeamDoseVerificationControlPointSequencegetBeamDoseVerificationControlPointSequence ()
 get BeamDoseVerificationControlPointSequence (300a,008c) More...
 
const
DRTBeamDoseVerificationControlPointSequence
getBeamDoseVerificationControlPointSequence () const
 get BeamDoseVerificationControlPointSequence (300a,008c) More...
 
OFCondition setAlternateBeamDose (const OFString &value, const OFBool check=OFTrue)
 set AlternateBeamDose (300a,0091) More...
 
OFCondition setAlternateBeamDoseType (const OFString &value, const OFBool check=OFTrue)
 set AlternateBeamDoseType (300a,0092) More...
 
OFCondition setBeamDeliveryDurationLimit (const Float64 value, const unsigned long pos=0)
 set BeamDeliveryDurationLimit (300a,00c5) More...
 
OFCondition setBeamDose (const OFString &value, const OFBool check=OFTrue)
 set BeamDose (300a,0084) More...
 
OFCondition setBeamDoseSpecificationPoint (const OFString &value, const OFBool check=OFTrue)
 set BeamDoseSpecificationPoint (300a,0082) More...
 
OFCondition setBeamDoseType (const OFString &value, const OFBool check=OFTrue)
 set BeamDoseType (300a,0090) More...
 
OFCondition setBeamMeterset (const OFString &value, const OFBool check=OFTrue)
 set BeamMeterset (300a,0086) More...
 
OFCondition setReferencedBeamNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedBeamNumber (300c,0006) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmDecimalString AlternateBeamDose
 AlternateBeamDose (300a,0091) vr=DS, vm=1, type=3.
 
DcmCodeString AlternateBeamDoseType
 AlternateBeamDoseType (300a,0092) vr=CS, vm=1, type=1C.
 
DcmFloatingPointDouble BeamDeliveryDurationLimit
 BeamDeliveryDurationLimit (300a,00c5) vr=FD, vm=1, type=3.
 
DcmDecimalString BeamDose
 BeamDose (300a,0084) vr=DS, vm=1, type=3.
 
DcmDecimalString BeamDoseSpecificationPoint
 BeamDoseSpecificationPoint (300a,0082) vr=DS, vm=3, type=3.
 
DcmCodeString BeamDoseType
 BeamDoseType (300a,0090) vr=CS, vm=1, type=1C.
 
DRTBeamDoseVerificationControlPointSequence BeamDoseVerificationControlPointSequence
 BeamDoseVerificationControlPointSequence (300a,008c) vr=SQ, vm=1, type=3.
 
DcmDecimalString BeamMeterset
 BeamMeterset (300a,0086) vr=DS, vm=1, type=3.
 
DcmIntegerString ReferencedBeamNumber
 ReferencedBeamNumber (300c,0006) vr=IS, vm=1, type=1.
 

Additional Inherited Members

- Protected Member Functions inherited from DRTTypes
virtual ~DRTTypes ()
 destructor. More...
 
- Static Protected Member Functions inherited from DRTTypes
static OFCondition addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 add given element to the dataset. More...
 
static OFCondition getElementFromDataset (DcmItem &dataset, DcmElement &element)
 get element from dataset More...
 
static OFCondition getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
 get string value from element More...
 
static OFCondition getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
 get string value from dataset More...
 
static OFCondition putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
 put string value to dataset More...
 
static OFBool checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
 check element value for correct value multiplicity and type More...
 
static OFCondition getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 get element from dataset and check it for correct value multiplicity and type. More...
 
static OFCondition getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 get string value from dataset and check it for correct value multiplicity and type. More...
 

Detailed Description

Item class.

Constructor & Destructor Documentation

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item
DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getAlternateBeamDose ( OFString value,
const signed long  pos = 0 
) const

get AlternateBeamDose (300a,0091)

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 DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getAlternateBeamDose ( Float64 &  value,
const unsigned long  pos = 0 
) const

get AlternateBeamDose (300a,0091)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getAlternateBeamDoseType ( OFString value,
const signed long  pos = 0 
) const

get AlternateBeamDoseType (300a,0092)

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 DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDeliveryDurationLimit ( Float64 &  value,
const unsigned long  pos = 0 
) const

get BeamDeliveryDurationLimit (300a,00c5)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDose ( OFString value,
const signed long  pos = 0 
) const

get BeamDose (300a,0084)

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 DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDose ( Float64 &  value,
const unsigned long  pos = 0 
) const

get BeamDose (300a,0084)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDoseSpecificationPoint ( OFString value,
const signed long  pos = 0 
) const

get BeamDoseSpecificationPoint (300a,0082)

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 DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDoseSpecificationPoint ( Float64 &  value,
const unsigned long  pos = 0 
) const

get BeamDoseSpecificationPoint (300a,0082)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDoseSpecificationPoint ( OFVector< Float64 > &  value) const

get BeamDoseSpecificationPoint (300a,0082)

Parameters
valuereference to variable in which the value(s) should be stored
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDoseType ( OFString value,
const signed long  pos = 0 
) const

get BeamDoseType (300a,0090)

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
DRTBeamDoseVerificationControlPointSequence& DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDoseVerificationControlPointSequence ( )
inline

get BeamDoseVerificationControlPointSequence (300a,008c)

Returns
reference to sequence element
const DRTBeamDoseVerificationControlPointSequence& DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamDoseVerificationControlPointSequence ( ) const
inline

get BeamDoseVerificationControlPointSequence (300a,008c)

Returns
const reference to sequence element
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamMeterset ( OFString value,
const signed long  pos = 0 
) const

get BeamMeterset (300a,0086)

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 DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getBeamMeterset ( Float64 &  value,
const unsigned long  pos = 0 
) const

get BeamMeterset (300a,0086)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getReferencedBeamNumber ( OFString value,
const signed long  pos = 0 
) const

get ReferencedBeamNumber (300c,0006)

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 DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::getReferencedBeamNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ReferencedBeamNumber (300c,0006)

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
OFBool DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise
OFBool DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::isValid ( ) const

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

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

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::read ( DcmItem item)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setAlternateBeamDose ( const OFString value,
const OFBool  check = OFTrue 
)

set AlternateBeamDose (300a,0091)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setAlternateBeamDoseType ( const OFString value,
const OFBool  check = OFTrue 
)

set AlternateBeamDoseType (300a,0092)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setBeamDeliveryDurationLimit ( const Float64  value,
const unsigned long  pos = 0 
)

set BeamDeliveryDurationLimit (300a,00c5)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setBeamDose ( const OFString value,
const OFBool  check = OFTrue 
)

set BeamDose (300a,0084)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setBeamDoseSpecificationPoint ( const OFString value,
const OFBool  check = OFTrue 
)

set BeamDoseSpecificationPoint (300a,0082)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (3) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setBeamDoseType ( const OFString value,
const OFBool  check = OFTrue 
)

set BeamDoseType (300a,0090)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setBeamMeterset ( const OFString value,
const OFBool  check = OFTrue 
)

set BeamMeterset (300a,0086)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::setReferencedBeamNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set ReferencedBeamNumber (300c,0006)

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
OFCondition DRTReferencedBeamSequenceInRTGeneralTreatmentRecordModule::Item::write ( DcmItem item)

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 Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8