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

Item class. More...

+ Inheritance diagram for DRTContributingEquipmentSequence::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 getContributionDateTime (OFString &value, const signed long pos=0) const
 get ContributionDateTime (0018,a002) More...
 
OFCondition getContributionDescription (OFString &value, const signed long pos=0) const
 get ContributionDescription (0018,a003) More...
 
OFCondition getDateOfLastCalibration (OFString &value, const signed long pos=0) const
 get DateOfLastCalibration (0018,1200) More...
 
OFCondition getDeviceSerialNumber (OFString &value, const signed long pos=0) const
 get DeviceSerialNumber (0018,1000) More...
 
OFCondition getInstitutionAddress (OFString &value, const signed long pos=0) const
 get InstitutionAddress (0008,0081) More...
 
OFCondition getInstitutionName (OFString &value, const signed long pos=0) const
 get InstitutionName (0008,0080) More...
 
OFCondition getInstitutionalDepartmentName (OFString &value, const signed long pos=0) const
 get InstitutionalDepartmentName (0008,1040) More...
 
OFCondition getManufacturer (OFString &value, const signed long pos=0) const
 get Manufacturer (0008,0070) More...
 
OFCondition getManufacturerModelName (OFString &value, const signed long pos=0) const
 get ManufacturerModelName (0008,1090) More...
 
OFCondition getOperatorsName (OFString &value, const signed long pos=0) const
 get OperatorsName (0008,1070) More...
 
OFCondition getSoftwareVersions (OFString &value, const signed long pos=0) const
 get SoftwareVersions (0018,1020) More...
 
OFCondition getSpatialResolution (OFString &value, const signed long pos=0) const
 get SpatialResolution (0018,1050) More...
 
OFCondition getSpatialResolution (Float64 &value, const unsigned long pos=0) const
 get SpatialResolution (0018,1050) More...
 
OFCondition getStationName (OFString &value, const signed long pos=0) const
 get StationName (0008,1010) More...
 
OFCondition getTimeOfLastCalibration (OFString &value, const signed long pos=0) const
 get TimeOfLastCalibration (0018,1201) More...
 
DRTOperatorIdentificationSequencegetOperatorIdentificationSequence ()
 get OperatorIdentificationSequence (0008,1072) More...
 
const DRTOperatorIdentificationSequencegetOperatorIdentificationSequence () const
 get OperatorIdentificationSequence (0008,1072) More...
 
DRTPurposeOfReferenceCodeSequencegetPurposeOfReferenceCodeSequence ()
 get PurposeOfReferenceCodeSequence (0040,a170) More...
 
const DRTPurposeOfReferenceCodeSequencegetPurposeOfReferenceCodeSequence () const
 get PurposeOfReferenceCodeSequence (0040,a170) More...
 
OFCondition setContributionDateTime (const OFString &value, const OFBool check=OFTrue)
 set ContributionDateTime (0018,a002) More...
 
OFCondition setContributionDescription (const OFString &value, const OFBool check=OFTrue)
 set ContributionDescription (0018,a003) More...
 
OFCondition setDateOfLastCalibration (const OFString &value, const OFBool check=OFTrue)
 set DateOfLastCalibration (0018,1200) More...
 
OFCondition setDeviceSerialNumber (const OFString &value, const OFBool check=OFTrue)
 set DeviceSerialNumber (0018,1000) More...
 
OFCondition setInstitutionAddress (const OFString &value, const OFBool check=OFTrue)
 set InstitutionAddress (0008,0081) More...
 
OFCondition setInstitutionName (const OFString &value, const OFBool check=OFTrue)
 set InstitutionName (0008,0080) More...
 
OFCondition setInstitutionalDepartmentName (const OFString &value, const OFBool check=OFTrue)
 set InstitutionalDepartmentName (0008,1040) More...
 
OFCondition setManufacturer (const OFString &value, const OFBool check=OFTrue)
 set Manufacturer (0008,0070) More...
 
OFCondition setManufacturerModelName (const OFString &value, const OFBool check=OFTrue)
 set ManufacturerModelName (0008,1090) More...
 
OFCondition setOperatorsName (const OFString &value, const OFBool check=OFTrue)
 set OperatorsName (0008,1070) More...
 
OFCondition setSoftwareVersions (const OFString &value, const OFBool check=OFTrue)
 set SoftwareVersions (0018,1020) More...
 
OFCondition setSpatialResolution (const OFString &value, const OFBool check=OFTrue)
 set SpatialResolution (0018,1050) More...
 
OFCondition setStationName (const OFString &value, const OFBool check=OFTrue)
 set StationName (0008,1010) More...
 
OFCondition setTimeOfLastCalibration (const OFString &value, const OFBool check=OFTrue)
 set TimeOfLastCalibration (0018,1201) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmDateTime ContributionDateTime
 ContributionDateTime (0018,a002) vr=DT, vm=1, type=3.
 
DcmShortText ContributionDescription
 ContributionDescription (0018,a003) vr=ST, vm=1, type=3.
 
DcmDate DateOfLastCalibration
 DateOfLastCalibration (0018,1200) vr=DA, vm=1-n, type=3.
 
DcmLongString DeviceSerialNumber
 DeviceSerialNumber (0018,1000) vr=LO, vm=1, type=3.
 
DcmShortText InstitutionAddress
 InstitutionAddress (0008,0081) vr=ST, vm=1, type=3.
 
DcmLongString InstitutionName
 InstitutionName (0008,0080) vr=LO, vm=1, type=3.
 
DcmLongString InstitutionalDepartmentName
 InstitutionalDepartmentName (0008,1040) vr=LO, vm=1, type=3.
 
DcmLongString Manufacturer
 Manufacturer (0008,0070) vr=LO, vm=1, type=1.
 
DcmLongString ManufacturerModelName
 ManufacturerModelName (0008,1090) vr=LO, vm=1, type=3.
 
DRTOperatorIdentificationSequence OperatorIdentificationSequence
 OperatorIdentificationSequence (0008,1072) vr=SQ, vm=1, type=3.
 
DcmPersonName OperatorsName
 OperatorsName (0008,1070) vr=PN, vm=1-n, type=3.
 
DRTPurposeOfReferenceCodeSequence PurposeOfReferenceCodeSequence
 PurposeOfReferenceCodeSequence (0040,a170) vr=SQ, vm=1, type=1.
 
DcmLongString SoftwareVersions
 SoftwareVersions (0018,1020) vr=LO, vm=1-n, type=3.
 
DcmDecimalString SpatialResolution
 SpatialResolution (0018,1050) vr=DS, vm=1, type=3.
 
DcmShortString StationName
 StationName (0008,1010) vr=SH, vm=1, type=3.
 
DcmTime TimeOfLastCalibration
 TimeOfLastCalibration (0018,1201) vr=TM, vm=1-n, type=3.
 

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]

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTContributingEquipmentSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getContributionDateTime()

OFCondition DRTContributingEquipmentSequence::Item::getContributionDateTime ( OFString value,
const signed long  pos = 0 
) const

get ContributionDateTime (0018,a002)

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

◆ getContributionDescription()

OFCondition DRTContributingEquipmentSequence::Item::getContributionDescription ( OFString value,
const signed long  pos = 0 
) const

get ContributionDescription (0018,a003)

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

◆ getDateOfLastCalibration()

OFCondition DRTContributingEquipmentSequence::Item::getDateOfLastCalibration ( OFString value,
const signed long  pos = 0 
) const

get DateOfLastCalibration (0018,1200)

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

◆ getDeviceSerialNumber()

OFCondition DRTContributingEquipmentSequence::Item::getDeviceSerialNumber ( OFString value,
const signed long  pos = 0 
) const

get DeviceSerialNumber (0018,1000)

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

◆ getInstitutionAddress()

OFCondition DRTContributingEquipmentSequence::Item::getInstitutionAddress ( OFString value,
const signed long  pos = 0 
) const

get InstitutionAddress (0008,0081)

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

◆ getInstitutionalDepartmentName()

OFCondition DRTContributingEquipmentSequence::Item::getInstitutionalDepartmentName ( OFString value,
const signed long  pos = 0 
) const

get InstitutionalDepartmentName (0008,1040)

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

◆ getInstitutionName()

OFCondition DRTContributingEquipmentSequence::Item::getInstitutionName ( OFString value,
const signed long  pos = 0 
) const

get InstitutionName (0008,0080)

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

◆ getManufacturer()

OFCondition DRTContributingEquipmentSequence::Item::getManufacturer ( OFString value,
const signed long  pos = 0 
) const

get Manufacturer (0008,0070)

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

◆ getManufacturerModelName()

OFCondition DRTContributingEquipmentSequence::Item::getManufacturerModelName ( OFString value,
const signed long  pos = 0 
) const

get ManufacturerModelName (0008,1090)

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

◆ getOperatorIdentificationSequence() [1/2]

DRTOperatorIdentificationSequence& DRTContributingEquipmentSequence::Item::getOperatorIdentificationSequence ( )
inline

get OperatorIdentificationSequence (0008,1072)

Returns
reference to sequence element

◆ getOperatorIdentificationSequence() [2/2]

const DRTOperatorIdentificationSequence& DRTContributingEquipmentSequence::Item::getOperatorIdentificationSequence ( ) const
inline

get OperatorIdentificationSequence (0008,1072)

Returns
const reference to sequence element

◆ getOperatorsName()

OFCondition DRTContributingEquipmentSequence::Item::getOperatorsName ( OFString value,
const signed long  pos = 0 
) const

get OperatorsName (0008,1070)

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

◆ getPurposeOfReferenceCodeSequence() [1/2]

DRTPurposeOfReferenceCodeSequence& DRTContributingEquipmentSequence::Item::getPurposeOfReferenceCodeSequence ( )
inline

get PurposeOfReferenceCodeSequence (0040,a170)

Returns
reference to sequence element

◆ getPurposeOfReferenceCodeSequence() [2/2]

const DRTPurposeOfReferenceCodeSequence& DRTContributingEquipmentSequence::Item::getPurposeOfReferenceCodeSequence ( ) const
inline

get PurposeOfReferenceCodeSequence (0040,a170)

Returns
const reference to sequence element

◆ getSoftwareVersions()

OFCondition DRTContributingEquipmentSequence::Item::getSoftwareVersions ( OFString value,
const signed long  pos = 0 
) const

get SoftwareVersions (0018,1020)

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

◆ getSpatialResolution() [1/2]

OFCondition DRTContributingEquipmentSequence::Item::getSpatialResolution ( OFString value,
const signed long  pos = 0 
) const

get SpatialResolution (0018,1050)

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

◆ getSpatialResolution() [2/2]

OFCondition DRTContributingEquipmentSequence::Item::getSpatialResolution ( Float64 &  value,
const unsigned long  pos = 0 
) const

get SpatialResolution (0018,1050)

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

◆ getStationName()

OFCondition DRTContributingEquipmentSequence::Item::getStationName ( OFString value,
const signed long  pos = 0 
) const

get StationName (0008,1010)

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

◆ getTimeOfLastCalibration()

OFCondition DRTContributingEquipmentSequence::Item::getTimeOfLastCalibration ( OFString value,
const signed long  pos = 0 
) const

get TimeOfLastCalibration (0018,1201)

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

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTContributingEquipmentSequence::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& DRTContributingEquipmentSequence::Item::operator= ( const Item copy)

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

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

◆ setContributionDateTime()

OFCondition DRTContributingEquipmentSequence::Item::setContributionDateTime ( const OFString value,
const OFBool  check = OFTrue 
)

set ContributionDateTime (0018,a002)

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

◆ setContributionDescription()

OFCondition DRTContributingEquipmentSequence::Item::setContributionDescription ( const OFString value,
const OFBool  check = OFTrue 
)

set ContributionDescription (0018,a003)

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

◆ setDateOfLastCalibration()

OFCondition DRTContributingEquipmentSequence::Item::setDateOfLastCalibration ( const OFString value,
const OFBool  check = OFTrue 
)

set DateOfLastCalibration (0018,1200)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (DA) and VM (1-n) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ setDeviceSerialNumber()

OFCondition DRTContributingEquipmentSequence::Item::setDeviceSerialNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set DeviceSerialNumber (0018,1000)

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

◆ setInstitutionAddress()

OFCondition DRTContributingEquipmentSequence::Item::setInstitutionAddress ( const OFString value,
const OFBool  check = OFTrue 
)

set InstitutionAddress (0008,0081)

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

◆ setInstitutionalDepartmentName()

OFCondition DRTContributingEquipmentSequence::Item::setInstitutionalDepartmentName ( const OFString value,
const OFBool  check = OFTrue 
)

set InstitutionalDepartmentName (0008,1040)

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

◆ setInstitutionName()

OFCondition DRTContributingEquipmentSequence::Item::setInstitutionName ( const OFString value,
const OFBool  check = OFTrue 
)

set InstitutionName (0008,0080)

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

◆ setManufacturer()

OFCondition DRTContributingEquipmentSequence::Item::setManufacturer ( const OFString value,
const OFBool  check = OFTrue 
)

set Manufacturer (0008,0070)

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

◆ setManufacturerModelName()

OFCondition DRTContributingEquipmentSequence::Item::setManufacturerModelName ( const OFString value,
const OFBool  check = OFTrue 
)

set ManufacturerModelName (0008,1090)

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

◆ setOperatorsName()

OFCondition DRTContributingEquipmentSequence::Item::setOperatorsName ( const OFString value,
const OFBool  check = OFTrue 
)

set OperatorsName (0008,1070)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (PN) and VM (1-n) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ setSoftwareVersions()

OFCondition DRTContributingEquipmentSequence::Item::setSoftwareVersions ( const OFString value,
const OFBool  check = OFTrue 
)

set SoftwareVersions (0018,1020)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (LO) and VM (1-n) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ setSpatialResolution()

OFCondition DRTContributingEquipmentSequence::Item::setSpatialResolution ( const OFString value,
const OFBool  check = OFTrue 
)

set SpatialResolution (0018,1050)

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

◆ setStationName()

OFCondition DRTContributingEquipmentSequence::Item::setStationName ( const OFString value,
const OFBool  check = OFTrue 
)

set StationName (0008,1010)

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

◆ setTimeOfLastCalibration()

OFCondition DRTContributingEquipmentSequence::Item::setTimeOfLastCalibration ( const OFString value,
const OFBool  check = OFTrue 
)

set TimeOfLastCalibration (0018,1201)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (TM) and VM (1-n) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ write()

OFCondition DRTContributingEquipmentSequence::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 Mon Oct 28 2019 for DCMTK Version 3.6.5 by Doxygen 1.8.15