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

Item class. More...

+ Inheritance diagram for DRTReferencedImageSequence::Item:
+ Collaboration diagram for DRTReferencedImageSequence::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 getCodeMeaning (OFString &value, const signed long pos=0) const
 get CodeMeaning (0008,0104) More...
 
OFCondition getCodeValue (OFString &value, const signed long pos=0) const
 get CodeValue (0008,0100) More...
 
OFCondition getCodingSchemeDesignator (OFString &value, const signed long pos=0) const
 get CodingSchemeDesignator (0008,0102) More...
 
OFCondition getCodingSchemeVersion (OFString &value, const signed long pos=0) const
 get CodingSchemeVersion (0008,0103) More...
 
OFCondition getContextGroupExtensionCreatorUID (OFString &value, const signed long pos=0) const
 get ContextGroupExtensionCreatorUID (0008,010d) More...
 
OFCondition getContextGroupExtensionFlag (OFString &value, const signed long pos=0) const
 get ContextGroupExtensionFlag (0008,010b) More...
 
OFCondition getContextGroupLocalVersion (OFString &value, const signed long pos=0) const
 get ContextGroupLocalVersion (0008,0107) More...
 
OFCondition getContextGroupVersion (OFString &value, const signed long pos=0) const
 get ContextGroupVersion (0008,0106) More...
 
OFCondition getContextIdentifier (OFString &value, const signed long pos=0) const
 get ContextIdentifier (0008,010f) More...
 
OFCondition getMappingResource (OFString &value, const signed long pos=0) const
 get MappingResource (0008,0105) More...
 
OFCondition getReferencedFrameNumber (OFString &value, const signed long pos=0) const
 get ReferencedFrameNumber (0008,1160) More...
 
OFCondition getReferencedFrameNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedFrameNumber (0008,1160) 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 getReferencedSegmentNumber (Uint16 &value, const unsigned long pos=0) const
 get ReferencedSegmentNumber (0062,000b) More...
 
DRTPurposeOfReferenceCodeSequencegetPurposeOfReferenceCodeSequence ()
 get PurposeOfReferenceCodeSequence (0040,a170) More...
 
const
DRTPurposeOfReferenceCodeSequence
getPurposeOfReferenceCodeSequence () const
 get PurposeOfReferenceCodeSequence (0040,a170) More...
 
OFCondition setCodeMeaning (const OFString &value, const OFBool check=OFTrue)
 set CodeMeaning (0008,0104) More...
 
OFCondition setCodeValue (const OFString &value, const OFBool check=OFTrue)
 set CodeValue (0008,0100) More...
 
OFCondition setCodingSchemeDesignator (const OFString &value, const OFBool check=OFTrue)
 set CodingSchemeDesignator (0008,0102) More...
 
OFCondition setCodingSchemeVersion (const OFString &value, const OFBool check=OFTrue)
 set CodingSchemeVersion (0008,0103) More...
 
OFCondition setContextGroupExtensionCreatorUID (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupExtensionCreatorUID (0008,010d) More...
 
OFCondition setContextGroupExtensionFlag (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupExtensionFlag (0008,010b) More...
 
OFCondition setContextGroupLocalVersion (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupLocalVersion (0008,0107) More...
 
OFCondition setContextGroupVersion (const OFString &value, const OFBool check=OFTrue)
 set ContextGroupVersion (0008,0106) More...
 
OFCondition setContextIdentifier (const OFString &value, const OFBool check=OFTrue)
 set ContextIdentifier (0008,010f) More...
 
OFCondition setMappingResource (const OFString &value, const OFBool check=OFTrue)
 set MappingResource (0008,0105) More...
 
OFCondition setReferencedFrameNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedFrameNumber (0008,1160) 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 setReferencedSegmentNumber (const Uint16 value, const unsigned long pos=0)
 set ReferencedSegmentNumber (0062,000b) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmLongString CodeMeaning
 CodeMeaning (0008,0104) vr=LO, vm=1, type=1C.
 
DcmShortString CodeValue
 CodeValue (0008,0100) vr=SH, vm=1, type=1C.
 
DcmShortString CodingSchemeDesignator
 CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1C.
 
DcmShortString CodingSchemeVersion
 CodingSchemeVersion (0008,0103) vr=SH, vm=1, type=1C.
 
DcmUniqueIdentifier ContextGroupExtensionCreatorUID
 ContextGroupExtensionCreatorUID (0008,010d) vr=UI, vm=1, type=1C.
 
DcmCodeString ContextGroupExtensionFlag
 ContextGroupExtensionFlag (0008,010b) vr=CS, vm=1, type=3.
 
DcmDateTime ContextGroupLocalVersion
 ContextGroupLocalVersion (0008,0107) vr=DT, vm=1, type=1C.
 
DcmDateTime ContextGroupVersion
 ContextGroupVersion (0008,0106) vr=DT, vm=1, type=1C.
 
DcmCodeString ContextIdentifier
 ContextIdentifier (0008,010f) vr=CS, vm=1, type=3.
 
DcmCodeString MappingResource
 MappingResource (0008,0105) vr=CS, vm=1, type=1C.
 
DRTPurposeOfReferenceCodeSequence PurposeOfReferenceCodeSequence
 PurposeOfReferenceCodeSequence (0040,a170) vr=SQ, vm=1, type=3.
 
DcmIntegerString ReferencedFrameNumber
 ReferencedFrameNumber (0008,1160) vr=IS, vm=1-n, type=1C.
 
DcmUniqueIdentifier ReferencedSOPClassUID
 ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1.
 
DcmUniqueIdentifier ReferencedSOPInstanceUID
 ReferencedSOPInstanceUID (0008,1155) vr=UI, vm=1, type=1.
 
DcmUnsignedShort ReferencedSegmentNumber
 ReferencedSegmentNumber (0062,000b) vr=US, vm=1-n, type=1C.
 

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

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

(default) constructor

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

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTReferencedImageSequence::Item::getCodeMeaning ( OFString value,
const signed long  pos = 0 
) const

get CodeMeaning (0008,0104)

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

get CodeValue (0008,0100)

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

get CodingSchemeDesignator (0008,0102)

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

get CodingSchemeVersion (0008,0103)

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

get ContextGroupExtensionCreatorUID (0008,010d)

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

get ContextGroupExtensionFlag (0008,010b)

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

get ContextGroupLocalVersion (0008,0107)

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

get ContextGroupVersion (0008,0106)

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

get ContextIdentifier (0008,010f)

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

get MappingResource (0008,0105)

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
DRTPurposeOfReferenceCodeSequence& DRTReferencedImageSequence::Item::getPurposeOfReferenceCodeSequence ( )
inline

get PurposeOfReferenceCodeSequence (0040,a170)

Returns
reference to sequence element
const DRTPurposeOfReferenceCodeSequence& DRTReferencedImageSequence::Item::getPurposeOfReferenceCodeSequence ( ) const
inline

get PurposeOfReferenceCodeSequence (0040,a170)

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

get ReferencedFrameNumber (0008,1160)

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 DRTReferencedImageSequence::Item::getReferencedFrameNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ReferencedFrameNumber (0008,1160)

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 DRTReferencedImageSequence::Item::getReferencedSegmentNumber ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get ReferencedSegmentNumber (0062,000b)

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

check if item is empty

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

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

Returns
OFTrue if item is valid, OFFalse otherwise
Item& DRTReferencedImageSequence::Item::operator= ( const Item copy)

assigment operator

Parameters
copyitem object to be copied
OFCondition DRTReferencedImageSequence::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 DRTReferencedImageSequence::Item::setCodeMeaning ( const OFString value,
const OFBool  check = OFTrue 
)

set CodeMeaning (0008,0104)

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

set CodeValue (0008,0100)

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

set CodingSchemeDesignator (0008,0102)

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

set CodingSchemeVersion (0008,0103)

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

set ContextGroupExtensionCreatorUID (0008,010d)

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

set ContextGroupExtensionFlag (0008,010b)

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

set ContextGroupLocalVersion (0008,0107)

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

set ContextGroupVersion (0008,0106)

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

set ContextIdentifier (0008,010f)

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

set MappingResource (0008,0105)

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

set ReferencedFrameNumber (0008,1160)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (IS) and VM (1-n) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedImageSequence::Item::setReferencedSegmentNumber ( const Uint16  value,
const unsigned long  pos = 0 
)

set ReferencedSegmentNumber (0062,000b)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1-n
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTReferencedImageSequence::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 DRTReferencedImageSequence::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 DRTReferencedImageSequence::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 Wed Sep 4 2013 for DCMTK Version 3.6.1 20121102 by Doxygen 1.8.4