DCMTK  Version 3.6.1 20131114
OFFIS DICOM Toolkit
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes | List of all members
DRTOriginalAttributesSequence::Item Class Reference

Item class. More...

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

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.
 

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

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item
DRTOriginalAttributesSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTOriginalAttributesSequence::Item::getAttributeModificationDateTime ( OFString value,
const signed long  pos = 0 
) const

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
DRTModifiedAttributesSequence& DRTOriginalAttributesSequence::Item::getModifiedAttributesSequence ( )
inline

get ModifiedAttributesSequence (0400,0550)

Returns
reference to sequence element
const DRTModifiedAttributesSequence& DRTOriginalAttributesSequence::Item::getModifiedAttributesSequence ( ) const
inline

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

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

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

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise
OFBool DRTOriginalAttributesSequence::Item::isValid ( ) const

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

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

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
OFCondition DRTOriginalAttributesSequence::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 Tue Nov 26 2013 for DCMTK Version 3.6.1 20131114 by Doxygen 1.8.5