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

Item class. More...

+ Inheritance diagram for DRTOriginalAttributesSequence::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 getAttributeModificationDateTime (OFString &value, const signed long pos=0) const
 get AttributeModificationDateTime (0400,0562)
OFCondition getHL7InstanceIdentifier (OFString &value, const signed long pos=0) const
 get HL7InstanceIdentifier (0040,e001)
OFCondition getModifyingSystem (OFString &value, const signed long pos=0) const
 get ModifyingSystem (0400,0563)
OFCondition getReasonForTheAttributeModification (OFString &value, const signed long pos=0) const
 get ReasonForTheAttributeModification (0400,0565)
OFCondition getReferencedSOPClassUID (OFString &value, const signed long pos=0) const
 get ReferencedSOPClassUID (0008,1150)
OFCondition getReferencedSOPInstanceUID (OFString &value, const signed long pos=0) const
 get ReferencedSOPInstanceUID (0008,1155)
OFCondition getRetrieveURI (OFString &value, const signed long pos=0) const
 get RetrieveURI (0040,e010)
OFCondition getSourceOfPreviousValues (OFString &value, const signed long pos=0) const
 get SourceOfPreviousValues (0400,0564)
DRTModifiedAttributesSequencegetModifiedAttributesSequence ()
 get ModifiedAttributesSequence (0400,0550)
const
DRTModifiedAttributesSequence
getModifiedAttributesSequence () const
 get ModifiedAttributesSequence (0400,0550)
OFCondition setAttributeModificationDateTime (const OFString &value, const OFBool check=OFTrue)
 set AttributeModificationDateTime (0400,0562)
OFCondition setHL7InstanceIdentifier (const OFString &value, const OFBool check=OFTrue)
 set HL7InstanceIdentifier (0040,e001)
OFCondition setModifyingSystem (const OFString &value, const OFBool check=OFTrue)
 set ModifyingSystem (0400,0563)
OFCondition setReasonForTheAttributeModification (const OFString &value, const OFBool check=OFTrue)
 set ReasonForTheAttributeModification (0400,0565)
OFCondition setReferencedSOPClassUID (const OFString &value, const OFBool check=OFTrue)
 set ReferencedSOPClassUID (0008,1150)
OFCondition setReferencedSOPInstanceUID (const OFString &value, const OFBool check=OFTrue)
 set ReferencedSOPInstanceUID (0008,1155)
OFCondition setRetrieveURI (const OFString &value, const OFBool check=OFTrue)
 set RetrieveURI (0040,e010)
OFCondition setSourceOfPreviousValues (const OFString &value, const OFBool check=OFTrue)
 set SourceOfPreviousValues (0400,0564)

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
DcmDateTime AttributeModificationDateTime
 AttributeModificationDateTime (0400,0562) vr=DT, vm=1, type=1.
DcmShortText HL7InstanceIdentifier
 HL7InstanceIdentifier (0040,e001) vr=ST, vm=1, type=1.
DRTModifiedAttributesSequence ModifiedAttributesSequence
 ModifiedAttributesSequence (0400,0550) vr=SQ, vm=1, type=1.
DcmLongString ModifyingSystem
 ModifyingSystem (0400,0563) vr=LO, vm=1, type=1.
DcmCodeString ReasonForTheAttributeModification
 ReasonForTheAttributeModification (0400,0565) vr=CS, vm=1, type=1.
DcmUniqueIdentifier ReferencedSOPClassUID
 ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1.
DcmUniqueIdentifier ReferencedSOPInstanceUID
 ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1.
DcmUnlimitedText RetrieveURI
 RetrieveURI (0040,e010) vr=UT, vm=1, type=3.
DcmLongString SourceOfPreviousValues
 SourceOfPreviousValues (0400,0564) vr=LO, vm=1, type=2.

Detailed Description

Item class.


Constructor & Destructor Documentation

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

get AttributeModificationDateTime (0400,0562)

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

get HL7InstanceIdentifier (0040,e001)

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 ModifiedAttributesSequence (0400,0550)

Returns:
reference to sequence element

get ModifiedAttributesSequence (0400,0550)

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

get ModifyingSystem (0400,0563)

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 ReasonForTheAttributeModification (0400,0565)

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

get ReferencedSOPClassUID (0008,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

get ReferencedSOPInstanceUID (0008,1155)

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

get RetrieveURI (0040,e010)

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

get SourceOfPreviousValues (0400,0564)

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

set AttributeModificationDateTime (0400,0562)

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

set HL7InstanceIdentifier (0040,e001)

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

set ModifyingSystem (0400,0563)

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

set ReasonForTheAttributeModification (0400,0565)

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

set ReferencedSOPClassUID (0008,1150)

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

set ReferencedSOPInstanceUID (0008,1155)

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

set RetrieveURI (0040,e010)

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

set SourceOfPreviousValues (0400,0564)

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

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