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

Item class. More...

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

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.
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.

Detailed Description

Item class.


Constructor & Destructor Documentation

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

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

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

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

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

get PurposeOfReferenceCodeSequence (0040,a170)

Returns:
reference to sequence element

get PurposeOfReferenceCodeSequence (0040,a170)

Returns:
const reference to sequence element
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
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
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
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

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

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

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