DCMTK  Version 3.6.7
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | List of all members
DRTWedgeSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTWedgeSequence::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 getAccessoryCode (OFString &value, const signed long pos=0) const
 get AccessoryCode (300a,00f9) More...
 
OFCondition getEffectiveWedgeAngle (OFString &value, const signed long pos=0) const
 get EffectiveWedgeAngle (300a,00de) More...
 
OFCondition getEffectiveWedgeAngle (Float64 &value, const unsigned long pos=0) const
 get EffectiveWedgeAngle (300a,00de) More...
 
OFCondition getSourceToWedgeTrayDistance (OFString &value, const signed long pos=0) const
 get SourceToWedgeTrayDistance (300a,00da) More...
 
OFCondition getSourceToWedgeTrayDistance (Float64 &value, const unsigned long pos=0) const
 get SourceToWedgeTrayDistance (300a,00da) More...
 
OFCondition getWedgeAngle (OFString &value, const signed long pos=0) const
 get WedgeAngle (300a,00d5) More...
 
OFCondition getWedgeAngle (Sint32 &value, const unsigned long pos=0) const
 get WedgeAngle (300a,00d5) More...
 
OFCondition getWedgeFactor (OFString &value, const signed long pos=0) const
 get WedgeFactor (300a,00d6) More...
 
OFCondition getWedgeFactor (Float64 &value, const unsigned long pos=0) const
 get WedgeFactor (300a,00d6) More...
 
OFCondition getWedgeID (OFString &value, const signed long pos=0) const
 get WedgeID (300a,00d4) More...
 
OFCondition getWedgeNumber (OFString &value, const signed long pos=0) const
 get WedgeNumber (300a,00d2) More...
 
OFCondition getWedgeNumber (Sint32 &value, const unsigned long pos=0) const
 get WedgeNumber (300a,00d2) More...
 
OFCondition getWedgeOrientation (OFString &value, const signed long pos=0) const
 get WedgeOrientation (300a,00d8) More...
 
OFCondition getWedgeOrientation (Float64 &value, const unsigned long pos=0) const
 get WedgeOrientation (300a,00d8) More...
 
OFCondition getWedgeType (OFString &value, const signed long pos=0) const
 get WedgeType (300a,00d3) More...
 
OFCondition setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
 set AccessoryCode (300a,00f9) More...
 
OFCondition setEffectiveWedgeAngle (const OFString &value, const OFBool check=OFTrue)
 set EffectiveWedgeAngle (300a,00de) More...
 
OFCondition setSourceToWedgeTrayDistance (const OFString &value, const OFBool check=OFTrue)
 set SourceToWedgeTrayDistance (300a,00da) More...
 
OFCondition setWedgeAngle (const OFString &value, const OFBool check=OFTrue)
 set WedgeAngle (300a,00d5) More...
 
OFCondition setWedgeFactor (const OFString &value, const OFBool check=OFTrue)
 set WedgeFactor (300a,00d6) More...
 
OFCondition setWedgeID (const OFString &value, const OFBool check=OFTrue)
 set WedgeID (300a,00d4) More...
 
OFCondition setWedgeNumber (const OFString &value, const OFBool check=OFTrue)
 set WedgeNumber (300a,00d2) More...
 
OFCondition setWedgeOrientation (const OFString &value, const OFBool check=OFTrue)
 set WedgeOrientation (300a,00d8) More...
 
OFCondition setWedgeType (const OFString &value, const OFBool check=OFTrue)
 set WedgeType (300a,00d3) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmLongString AccessoryCode
 AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
 
DcmDecimalString EffectiveWedgeAngle
 EffectiveWedgeAngle (300a,00de) vr=DS, vm=1, type=3.
 
DcmDecimalString SourceToWedgeTrayDistance
 SourceToWedgeTrayDistance (300a,00da) vr=DS, vm=1, type=3.
 
DcmIntegerString WedgeAngle
 WedgeAngle (300a,00d5) vr=IS, vm=1, type=2.
 
DcmDecimalString WedgeFactor
 WedgeFactor (300a,00d6) vr=DS, vm=1, type=2.
 
DcmShortString WedgeID
 WedgeID (300a,00d4) vr=SH, vm=1, type=3.
 
DcmIntegerString WedgeNumber
 WedgeNumber (300a,00d2) vr=IS, vm=1, type=1.
 
DcmDecimalString WedgeOrientation
 WedgeOrientation (300a,00d8) vr=DS, vm=1, type=2.
 
DcmCodeString WedgeType
 WedgeType (300a,00d3) vr=CS, vm=1, type=2.
 

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

◆ Item() [1/2]

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTWedgeSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getAccessoryCode()

OFCondition DRTWedgeSequence::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

◆ getEffectiveWedgeAngle() [1/2]

OFCondition DRTWedgeSequence::Item::getEffectiveWedgeAngle ( Float64 &  value,
const unsigned long  pos = 0 
) const

get EffectiveWedgeAngle (300a,00de)

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

◆ getEffectiveWedgeAngle() [2/2]

OFCondition DRTWedgeSequence::Item::getEffectiveWedgeAngle ( OFString value,
const signed long  pos = 0 
) const

get EffectiveWedgeAngle (300a,00de)

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

◆ getSourceToWedgeTrayDistance() [1/2]

OFCondition DRTWedgeSequence::Item::getSourceToWedgeTrayDistance ( Float64 &  value,
const unsigned long  pos = 0 
) const

get SourceToWedgeTrayDistance (300a,00da)

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

◆ getSourceToWedgeTrayDistance() [2/2]

OFCondition DRTWedgeSequence::Item::getSourceToWedgeTrayDistance ( OFString value,
const signed long  pos = 0 
) const

get SourceToWedgeTrayDistance (300a,00da)

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

◆ getWedgeAngle() [1/2]

OFCondition DRTWedgeSequence::Item::getWedgeAngle ( OFString value,
const signed long  pos = 0 
) const

get WedgeAngle (300a,00d5)

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

◆ getWedgeAngle() [2/2]

OFCondition DRTWedgeSequence::Item::getWedgeAngle ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get WedgeAngle (300a,00d5)

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

◆ getWedgeFactor() [1/2]

OFCondition DRTWedgeSequence::Item::getWedgeFactor ( Float64 &  value,
const unsigned long  pos = 0 
) const

get WedgeFactor (300a,00d6)

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

◆ getWedgeFactor() [2/2]

OFCondition DRTWedgeSequence::Item::getWedgeFactor ( OFString value,
const signed long  pos = 0 
) const

get WedgeFactor (300a,00d6)

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

◆ getWedgeID()

OFCondition DRTWedgeSequence::Item::getWedgeID ( OFString value,
const signed long  pos = 0 
) const

get WedgeID (300a,00d4)

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

◆ getWedgeNumber() [1/2]

OFCondition DRTWedgeSequence::Item::getWedgeNumber ( OFString value,
const signed long  pos = 0 
) const

get WedgeNumber (300a,00d2)

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

◆ getWedgeNumber() [2/2]

OFCondition DRTWedgeSequence::Item::getWedgeNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get WedgeNumber (300a,00d2)

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

◆ getWedgeOrientation() [1/2]

OFCondition DRTWedgeSequence::Item::getWedgeOrientation ( Float64 &  value,
const unsigned long  pos = 0 
) const

get WedgeOrientation (300a,00d8)

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

◆ getWedgeOrientation() [2/2]

OFCondition DRTWedgeSequence::Item::getWedgeOrientation ( OFString value,
const signed long  pos = 0 
) const

get WedgeOrientation (300a,00d8)

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

◆ getWedgeType()

OFCondition DRTWedgeSequence::Item::getWedgeType ( OFString value,
const signed long  pos = 0 
) const

get WedgeType (300a,00d3)

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

◆ isEmpty()

OFBool DRTWedgeSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTWedgeSequence::Item::isValid ( ) const

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

Returns
OFTrue if item is valid, OFFalse otherwise

◆ operator=()

Item& DRTWedgeSequence::Item::operator= ( const Item copy)

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

OFCondition DRTWedgeSequence::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

◆ setAccessoryCode()

OFCondition DRTWedgeSequence::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

◆ setEffectiveWedgeAngle()

OFCondition DRTWedgeSequence::Item::setEffectiveWedgeAngle ( const OFString value,
const OFBool  check = OFTrue 
)

set EffectiveWedgeAngle (300a,00de)

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

◆ setSourceToWedgeTrayDistance()

OFCondition DRTWedgeSequence::Item::setSourceToWedgeTrayDistance ( const OFString value,
const OFBool  check = OFTrue 
)

set SourceToWedgeTrayDistance (300a,00da)

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

◆ setWedgeAngle()

OFCondition DRTWedgeSequence::Item::setWedgeAngle ( const OFString value,
const OFBool  check = OFTrue 
)

set WedgeAngle (300a,00d5)

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

◆ setWedgeFactor()

OFCondition DRTWedgeSequence::Item::setWedgeFactor ( const OFString value,
const OFBool  check = OFTrue 
)

set WedgeFactor (300a,00d6)

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

◆ setWedgeID()

OFCondition DRTWedgeSequence::Item::setWedgeID ( const OFString value,
const OFBool  check = OFTrue 
)

set WedgeID (300a,00d4)

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

◆ setWedgeNumber()

OFCondition DRTWedgeSequence::Item::setWedgeNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set WedgeNumber (300a,00d2)

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

◆ setWedgeOrientation()

OFCondition DRTWedgeSequence::Item::setWedgeOrientation ( const OFString value,
const OFBool  check = OFTrue 
)

set WedgeOrientation (300a,00d8)

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

◆ setWedgeType()

OFCondition DRTWedgeSequence::Item::setWedgeType ( const OFString value,
const OFBool  check = OFTrue 
)

set WedgeType (300a,00d3)

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

◆ write()

OFCondition DRTWedgeSequence::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 Thu Apr 28 2022 for DCMTK Version 3.6.7 by Doxygen 1.9.1