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

Item class. More...

+ Inheritance diagram for DRTCompensatorSequence::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 getAccessoryCode (OFString &value, const signed long pos=0) const
 get AccessoryCode (300a,00f9)
OFCondition getCompensatorColumns (OFString &value, const signed long pos=0) const
 get CompensatorColumns (300a,00e8)
OFCondition getCompensatorColumns (Sint32 &value, const unsigned long pos=0) const
 get CompensatorColumns (300a,00e8)
OFCondition getCompensatorDivergence (OFString &value, const signed long pos=0) const
 get CompensatorDivergence (300a,02e0)
OFCondition getCompensatorID (OFString &value, const signed long pos=0) const
 get CompensatorID (300a,00e5)
OFCondition getCompensatorMountingPosition (OFString &value, const signed long pos=0) const
 get CompensatorMountingPosition (300a,02e1)
OFCondition getCompensatorNumber (OFString &value, const signed long pos=0) const
 get CompensatorNumber (300a,00e4)
OFCondition getCompensatorNumber (Sint32 &value, const unsigned long pos=0) const
 get CompensatorNumber (300a,00e4)
OFCondition getCompensatorPixelSpacing (OFString &value, const signed long pos=0) const
 get CompensatorPixelSpacing (300a,00e9)
OFCondition getCompensatorPixelSpacing (Float64 &value, const unsigned long pos=0) const
 get CompensatorPixelSpacing (300a,00e9)
OFCondition getCompensatorPixelSpacing (OFVector< Float64 > &value) const
 get CompensatorPixelSpacing (300a,00e9)
OFCondition getCompensatorPosition (OFString &value, const signed long pos=0) const
 get CompensatorPosition (300a,00ea)
OFCondition getCompensatorPosition (Float64 &value, const unsigned long pos=0) const
 get CompensatorPosition (300a,00ea)
OFCondition getCompensatorPosition (OFVector< Float64 > &value) const
 get CompensatorPosition (300a,00ea)
OFCondition getCompensatorRows (OFString &value, const signed long pos=0) const
 get CompensatorRows (300a,00e7)
OFCondition getCompensatorRows (Sint32 &value, const unsigned long pos=0) const
 get CompensatorRows (300a,00e7)
OFCondition getCompensatorThicknessData (OFString &value, const signed long pos=0) const
 get CompensatorThicknessData (300a,00ec)
OFCondition getCompensatorThicknessData (Float64 &value, const unsigned long pos=0) const
 get CompensatorThicknessData (300a,00ec)
OFCondition getCompensatorThicknessData (OFVector< Float64 > &value) const
 get CompensatorThicknessData (300a,00ec)
OFCondition getCompensatorTransmissionData (OFString &value, const signed long pos=0) const
 get CompensatorTransmissionData (300a,00eb)
OFCondition getCompensatorTransmissionData (Float64 &value, const unsigned long pos=0) const
 get CompensatorTransmissionData (300a,00eb)
OFCondition getCompensatorTransmissionData (OFVector< Float64 > &value) const
 get CompensatorTransmissionData (300a,00eb)
OFCondition getCompensatorType (OFString &value, const signed long pos=0) const
 get CompensatorType (300a,00ee)
OFCondition getMaterialID (OFString &value, const signed long pos=0) const
 get MaterialID (300a,00e1)
OFCondition getSourceToCompensatorDistance (OFString &value, const signed long pos=0) const
 get SourceToCompensatorDistance (300a,02e2)
OFCondition getSourceToCompensatorDistance (Float64 &value, const unsigned long pos=0) const
 get SourceToCompensatorDistance (300a,02e2)
OFCondition getSourceToCompensatorDistance (OFVector< Float64 > &value) const
 get SourceToCompensatorDistance (300a,02e2)
OFCondition getSourceToCompensatorTrayDistance (OFString &value, const signed long pos=0) const
 get SourceToCompensatorTrayDistance (300a,00e6)
OFCondition getSourceToCompensatorTrayDistance (Float64 &value, const unsigned long pos=0) const
 get SourceToCompensatorTrayDistance (300a,00e6)
OFCondition setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
 set AccessoryCode (300a,00f9)
OFCondition setCompensatorColumns (const OFString &value, const OFBool check=OFTrue)
 set CompensatorColumns (300a,00e8)
OFCondition setCompensatorDivergence (const OFString &value, const OFBool check=OFTrue)
 set CompensatorDivergence (300a,02e0)
OFCondition setCompensatorID (const OFString &value, const OFBool check=OFTrue)
 set CompensatorID (300a,00e5)
OFCondition setCompensatorMountingPosition (const OFString &value, const OFBool check=OFTrue)
 set CompensatorMountingPosition (300a,02e1)
OFCondition setCompensatorNumber (const OFString &value, const OFBool check=OFTrue)
 set CompensatorNumber (300a,00e4)
OFCondition setCompensatorPixelSpacing (const OFString &value, const OFBool check=OFTrue)
 set CompensatorPixelSpacing (300a,00e9)
OFCondition setCompensatorPosition (const OFString &value, const OFBool check=OFTrue)
 set CompensatorPosition (300a,00ea)
OFCondition setCompensatorRows (const OFString &value, const OFBool check=OFTrue)
 set CompensatorRows (300a,00e7)
OFCondition setCompensatorThicknessData (const OFString &value, const OFBool check=OFTrue)
 set CompensatorThicknessData (300a,00ec)
OFCondition setCompensatorTransmissionData (const OFString &value, const OFBool check=OFTrue)
 set CompensatorTransmissionData (300a,00eb)
OFCondition setCompensatorType (const OFString &value, const OFBool check=OFTrue)
 set CompensatorType (300a,00ee)
OFCondition setMaterialID (const OFString &value, const OFBool check=OFTrue)
 set MaterialID (300a,00e1)
OFCondition setSourceToCompensatorDistance (const OFString &value, const OFBool check=OFTrue)
 set SourceToCompensatorDistance (300a,02e2)
OFCondition setSourceToCompensatorTrayDistance (const OFString &value, const OFBool check=OFTrue)
 set SourceToCompensatorTrayDistance (300a,00e6)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmLongString AccessoryCode
 AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
DcmIntegerString CompensatorColumns
 CompensatorColumns (300a,00e8) vr=IS, vm=1, type=1C.
DcmCodeString CompensatorDivergence
 CompensatorDivergence (300a,02e0) vr=CS, vm=1, type=3.
DcmShortString CompensatorID
 CompensatorID (300a,00e5) vr=SH, vm=1, type=3.
DcmCodeString CompensatorMountingPosition
 CompensatorMountingPosition (300a,02e1) vr=CS, vm=1, type=3.
DcmIntegerString CompensatorNumber
 CompensatorNumber (300a,00e4) vr=IS, vm=1, type=1C.
DcmDecimalString CompensatorPixelSpacing
 CompensatorPixelSpacing (300a,00e9) vr=DS, vm=2, type=1C.
DcmDecimalString CompensatorPosition
 CompensatorPosition (300a,00ea) vr=DS, vm=2, type=1C.
DcmIntegerString CompensatorRows
 CompensatorRows (300a,00e7) vr=IS, vm=1, type=1C.
DcmDecimalString CompensatorThicknessData
 CompensatorThicknessData (300a,00ec) vr=DS, vm=1-n, type=1C.
DcmDecimalString CompensatorTransmissionData
 CompensatorTransmissionData (300a,00eb) vr=DS, vm=1-n, type=1C.
DcmCodeString CompensatorType
 CompensatorType (300a,00ee) vr=CS, vm=1, type=3.
DcmShortString MaterialID
 MaterialID (300a,00e1) vr=SH, vm=1, type=2C.
DcmDecimalString SourceToCompensatorDistance
 SourceToCompensatorDistance (300a,02e2) vr=DS, vm=1-n, type=1C.
DcmDecimalString SourceToCompensatorTrayDistance
 SourceToCompensatorTrayDistance (300a,00e6) vr=DS, vm=1, type=2C.

Detailed Description

Item class.


Constructor & Destructor Documentation

DRTCompensatorSequence::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

OFCondition DRTCompensatorSequence::Item::getAccessoryCode ( OFString value,
const signed long  pos = 0 
) const

get AccessoryCode (300a,00f9)

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

get CompensatorColumns (300a,00e8)

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

get CompensatorColumns (300a,00e8)

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

get CompensatorDivergence (300a,02e0)

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

get CompensatorID (300a,00e5)

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

get CompensatorMountingPosition (300a,02e1)

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

get CompensatorNumber (300a,00e4)

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

get CompensatorNumber (300a,00e4)

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

get CompensatorPixelSpacing (300a,00e9)

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

get CompensatorPixelSpacing (300a,00e9)

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 CompensatorPixelSpacing (300a,00e9)

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

get CompensatorPosition (300a,00ea)

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

get CompensatorPosition (300a,00ea)

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 CompensatorPosition (300a,00ea)

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

get CompensatorRows (300a,00e7)

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

get CompensatorRows (300a,00e7)

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

get CompensatorThicknessData (300a,00ec)

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

get CompensatorThicknessData (300a,00ec)

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 CompensatorThicknessData (300a,00ec)

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

get CompensatorTransmissionData (300a,00eb)

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

get CompensatorTransmissionData (300a,00eb)

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 CompensatorTransmissionData (300a,00eb)

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

get CompensatorType (300a,00ee)

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

get MaterialID (300a,00e1)

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

get SourceToCompensatorDistance (300a,02e2)

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

get SourceToCompensatorDistance (300a,02e2)

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 SourceToCompensatorDistance (300a,02e2)

Parameters:
valuereference to variable in which the value(s) should be stored
Returns:
status, EC_Normal if successful, an error code otherwise

get SourceToCompensatorTrayDistance (300a,00e6)

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

get SourceToCompensatorTrayDistance (300a,00e6)

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

set AccessoryCode (300a,00f9)

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

set CompensatorColumns (300a,00e8)

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

set CompensatorDivergence (300a,02e0)

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

set CompensatorID (300a,00e5)

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

set CompensatorMountingPosition (300a,02e1)

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

set CompensatorNumber (300a,00e4)

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

set CompensatorPixelSpacing (300a,00e9)

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

set CompensatorPosition (300a,00ea)

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

set CompensatorRows (300a,00e7)

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

set CompensatorThicknessData (300a,00ec)

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

set CompensatorTransmissionData (300a,00eb)

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

set CompensatorType (300a,00ee)

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

set MaterialID (300a,00e1)

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

set SourceToCompensatorDistance (300a,02e2)

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

set SourceToCompensatorTrayDistance (300a,00e6)

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