DCMTK  Version 3.6.1 20121102
OFFIS DICOM Toolkit
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes | List of all members
DRTExposureSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTExposureSequence::Item:
+ Collaboration diagram for DRTExposureSequence::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 getDiaphragmPosition (OFString &value, const signed long pos=0) const
 get DiaphragmPosition (3002,0034) More...
 
OFCondition getDiaphragmPosition (Float64 &value, const unsigned long pos=0) const
 get DiaphragmPosition (3002,0034) More...
 
OFCondition getDiaphragmPosition (OFVector< Float64 > &value) const
 get DiaphragmPosition (3002,0034) More...
 
OFCondition getExposureTime (OFString &value, const signed long pos=0) const
 get ExposureTime (0018,1150) More...
 
OFCondition getExposureTime (Sint32 &value, const unsigned long pos=0) const
 get ExposureTime (0018,1150) More...
 
OFCondition getFluenceDataScale (OFString &value, const signed long pos=0) const
 get FluenceDataScale (3002,0042) More...
 
OFCondition getFluenceDataScale (Float64 &value, const unsigned long pos=0) const
 get FluenceDataScale (3002,0042) More...
 
OFCondition getFluenceDataSource (OFString &value, const signed long pos=0) const
 get FluenceDataSource (3002,0041) More...
 
OFCondition getKVP (OFString &value, const signed long pos=0) const
 get KVP (0018,0060) More...
 
OFCondition getKVP (Float64 &value, const unsigned long pos=0) const
 get KVP (0018,0060) More...
 
OFCondition getMetersetExposure (OFString &value, const signed long pos=0) const
 get MetersetExposure (3002,0032) More...
 
OFCondition getMetersetExposure (Float64 &value, const unsigned long pos=0) const
 get MetersetExposure (3002,0032) More...
 
OFCondition getNumberOfBlocks (OFString &value, const signed long pos=0) const
 get NumberOfBlocks (300a,00f0) More...
 
OFCondition getNumberOfBlocks (Sint32 &value, const unsigned long pos=0) const
 get NumberOfBlocks (300a,00f0) More...
 
OFCondition getReferencedFrameNumber (OFString &value, const signed long pos=0) const
 get ReferencedFrameNumber (0008,1160) More...
 
OFCondition getReferencedFrameNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedFrameNumber (0008,1160) More...
 
OFCondition getXRayTubeCurrent (OFString &value, const signed long pos=0) const
 get XRayTubeCurrent (0018,1151) More...
 
OFCondition getXRayTubeCurrent (Sint32 &value, const unsigned long pos=0) const
 get XRayTubeCurrent (0018,1151) More...
 
DRTApplicatorSequenceInRTImageModulegetApplicatorSequence ()
 get ApplicatorSequence (300a,0107) More...
 
const
DRTApplicatorSequenceInRTImageModule
getApplicatorSequence () const
 get ApplicatorSequence (300a,0107) More...
 
DRTBeamLimitingDeviceSequenceInRTImageModulegetBeamLimitingDeviceSequence ()
 get BeamLimitingDeviceSequence (300a,00b6) More...
 
const
DRTBeamLimitingDeviceSequenceInRTImageModule
getBeamLimitingDeviceSequence () const
 get BeamLimitingDeviceSequence (300a,00b6) More...
 
DRTBlockSequenceInRTImageModulegetBlockSequence ()
 get BlockSequence (300a,00f4) More...
 
const
DRTBlockSequenceInRTImageModule
getBlockSequence () const
 get BlockSequence (300a,00f4) More...
 
OFCondition setDiaphragmPosition (const OFString &value, const OFBool check=OFTrue)
 set DiaphragmPosition (3002,0034) More...
 
OFCondition setExposureTime (const OFString &value, const OFBool check=OFTrue)
 set ExposureTime (0018,1150) More...
 
OFCondition setFluenceDataScale (const OFString &value, const OFBool check=OFTrue)
 set FluenceDataScale (3002,0042) More...
 
OFCondition setFluenceDataSource (const OFString &value, const OFBool check=OFTrue)
 set FluenceDataSource (3002,0041) More...
 
OFCondition setKVP (const OFString &value, const OFBool check=OFTrue)
 set KVP (0018,0060) More...
 
OFCondition setMetersetExposure (const OFString &value, const OFBool check=OFTrue)
 set MetersetExposure (3002,0032) More...
 
OFCondition setNumberOfBlocks (const OFString &value, const OFBool check=OFTrue)
 set NumberOfBlocks (300a,00f0) More...
 
OFCondition setReferencedFrameNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedFrameNumber (0008,1160) More...
 
OFCondition setXRayTubeCurrent (const OFString &value, const OFBool check=OFTrue)
 set XRayTubeCurrent (0018,1151) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DRTApplicatorSequenceInRTImageModule ApplicatorSequence
 ApplicatorSequence (300a,0107) vr=SQ, vm=1, type=3.
 
DRTBeamLimitingDeviceSequenceInRTImageModule BeamLimitingDeviceSequence
 BeamLimitingDeviceSequence (300a,00b6) vr=SQ, vm=1, type=3.
 
DRTBlockSequenceInRTImageModule BlockSequence
 BlockSequence (300a,00f4) vr=SQ, vm=1, type=2C.
 
DcmDecimalString DiaphragmPosition
 DiaphragmPosition (3002,0034) vr=DS, vm=4, type=3.
 
DcmIntegerString ExposureTime
 ExposureTime (0018,1150) vr=IS, vm=1, type=2C.
 
DcmDecimalString FluenceDataScale
 FluenceDataScale (3002,0042) vr=DS, vm=1, type=3.
 
DcmCodeString FluenceDataSource
 FluenceDataSource (3002,0041) vr=CS, vm=1, type=1.
 
DcmDecimalString KVP
 KVP (0018,0060) vr=DS, vm=1, type=2C.
 
DcmDecimalString MetersetExposure
 MetersetExposure (3002,0032) vr=DS, vm=1, type=2C.
 
DcmIntegerString NumberOfBlocks
 NumberOfBlocks (300a,00f0) vr=IS, vm=1, type=1C.
 
DcmIntegerString ReferencedFrameNumber
 ReferencedFrameNumber (0008,1160) vr=IS, vm=1-n, type=1C.
 
DcmIntegerString XRayTubeCurrent
 XRayTubeCurrent (0018,1151) vr=IS, vm=1, type=2C.
 

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

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

(default) constructor

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

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

DRTApplicatorSequenceInRTImageModule& DRTExposureSequence::Item::getApplicatorSequence ( )
inline

get ApplicatorSequence (300a,0107)

Returns
reference to sequence element
const DRTApplicatorSequenceInRTImageModule& DRTExposureSequence::Item::getApplicatorSequence ( ) const
inline

get ApplicatorSequence (300a,0107)

Returns
const reference to sequence element
DRTBeamLimitingDeviceSequenceInRTImageModule& DRTExposureSequence::Item::getBeamLimitingDeviceSequence ( )
inline

get BeamLimitingDeviceSequence (300a,00b6)

Returns
reference to sequence element
const DRTBeamLimitingDeviceSequenceInRTImageModule& DRTExposureSequence::Item::getBeamLimitingDeviceSequence ( ) const
inline

get BeamLimitingDeviceSequence (300a,00b6)

Returns
const reference to sequence element
DRTBlockSequenceInRTImageModule& DRTExposureSequence::Item::getBlockSequence ( )
inline

get BlockSequence (300a,00f4)

Returns
reference to sequence element
const DRTBlockSequenceInRTImageModule& DRTExposureSequence::Item::getBlockSequence ( ) const
inline

get BlockSequence (300a,00f4)

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

get DiaphragmPosition (3002,0034)

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

get DiaphragmPosition (3002,0034)

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 DRTExposureSequence::Item::getDiaphragmPosition ( OFVector< Float64 > &  value) const

get DiaphragmPosition (3002,0034)

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

get ExposureTime (0018,1150)

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

get ExposureTime (0018,1150)

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

get FluenceDataScale (3002,0042)

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

get FluenceDataScale (3002,0042)

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

get FluenceDataSource (3002,0041)

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

get KVP (0018,0060)

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

get KVP (0018,0060)

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

get MetersetExposure (3002,0032)

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

get MetersetExposure (3002,0032)

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

get NumberOfBlocks (300a,00f0)

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

get NumberOfBlocks (300a,00f0)

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

get ReferencedFrameNumber (0008,1160)

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

get ReferencedFrameNumber (0008,1160)

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

get XRayTubeCurrent (0018,1151)

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

get XRayTubeCurrent (0018,1151)

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

check if item is empty

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

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

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

assigment operator

Parameters
copyitem object to be copied
OFCondition DRTExposureSequence::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 DRTExposureSequence::Item::setDiaphragmPosition ( const OFString value,
const OFBool  check = OFTrue 
)

set DiaphragmPosition (3002,0034)

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

set ExposureTime (0018,1150)

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

set FluenceDataScale (3002,0042)

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

set FluenceDataSource (3002,0041)

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

set KVP (0018,0060)

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

set MetersetExposure (3002,0032)

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

set NumberOfBlocks (300a,00f0)

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

set ReferencedFrameNumber (0008,1160)

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

set XRayTubeCurrent (0018,1151)

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 DRTExposureSequence::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 Wed Sep 4 2013 for DCMTK Version 3.6.1 20121102 by Doxygen 1.8.4