OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
DSRContentItem Class Reference

Interface class for content items. More...

Inheritance diagram for DSRContentItem:
[legend]
Collaboration diagram for DSRContentItem:
[legend]

Public Member Functions

virtual ~DSRContentItem ()
 destructor
 
OFBool isValid () const
 check for validity/completeness.
 
OFBool isMarked () const
 check for mark flag.
 
void setMark (const OFBool flag)
 mark/unmark item.
 
E_ValueType getValueType () const
 get value type.
 
E_RelationshipType getRelationshipType () const
 get relationship type.
 
size_t getReferencedNodeID () const
 get ID of the referenced node.
 
const OFStringgetStringValue () const
 get string value.
 
OFCondition setStringValue (const OFString &stringValue)
 set string value.
 
DSRCodedEntryValuegetCodeValuePtr ()
 get pointer to code value.
 
const DSRCodedEntryValuegetCodeValue () const
 get code value.
 
OFCondition getCodeValue (DSRCodedEntryValue &codeValue) const
 get copy of code value.
 
OFCondition setCodeValue (const DSRCodedEntryValue &codeValue)
 set code value.
 
DSRNumericMeasurementValuegetNumericValuePtr ()
 get pointer to numeric value.
 
const DSRNumericMeasurementValuegetNumericValue () const
 get numeric value.
 
OFCondition getNumericValue (DSRNumericMeasurementValue &numericValue) const
 get copy of numeric value.
 
OFCondition setNumericValue (const DSRNumericMeasurementValue &numericValue)
 set numeric value.
 
DSRSpatialCoordinatesValuegetSpatialCoordinatesPtr ()
 get pointer to spatial coordinates.
 
const DSRSpatialCoordinatesValuegetSpatialCoordinates () const
 get spatial coordinates.
 
OFCondition getSpatialCoordinates (DSRSpatialCoordinatesValue &coordinatesValue) const
 get copy of spatial coordinates.
 
OFCondition setSpatialCoordinates (const DSRSpatialCoordinatesValue &coordinatesValue)
 set spatial coordinates.
 
DSRTemporalCoordinatesValuegetTemporalCoordinatesPtr ()
 get pointer to temporal coordinates.
 
const DSRTemporalCoordinatesValuegetTemporalCoordinates () const
 get temporal coordinates.
 
OFCondition getTemporalCoordinates (DSRTemporalCoordinatesValue &coordinatesValue) const
 get copy of temporal coordinates.
 
OFCondition setTemporalCoordinates (const DSRTemporalCoordinatesValue &coordinatesValue)
 set temporal coordinates.
 
DSRCompositeReferenceValuegetCompositeReferencePtr ()
 get pointer to composite reference.
 
const DSRCompositeReferenceValuegetCompositeReference () const
 get composite reference.
 
OFCondition getCompositeReference (DSRCompositeReferenceValue &referenceValue) const
 get copy of composite reference.
 
OFCondition setCompositeReference (const DSRCompositeReferenceValue &referenceValue)
 set composite reference.
 
DSRImageReferenceValuegetImageReferencePtr ()
 get pointer to image reference.
 
const DSRImageReferenceValuegetImageReference () const
 get image reference.
 
OFCondition getImageReference (DSRImageReferenceValue &referenceValue) const
 get copy of image reference.
 
OFCondition setImageReference (const DSRImageReferenceValue &referenceValue)
 set image reference.
 
DSRWaveformReferenceValuegetWaveformReferencePtr ()
 get pointer to waveform reference.
 
const DSRWaveformReferenceValuegetWaveformReference () const
 get waveform reference.
 
OFCondition getWaveformReference (DSRWaveformReferenceValue &referenceValue) const
 get copy of waveform reference.
 
OFCondition setWaveformReference (const DSRWaveformReferenceValue &referenceValue)
 set waveform reference.
 
E_ContinuityOfContent getContinuityOfContent () const
 get continuity of content flag.
 
OFCondition setContinuityOfContent (const E_ContinuityOfContent continuityOfContent)
 set continuity of content flag.
 
DSRCodedEntryValuegetConceptNamePtr ()
 get pointer to concept name.
 
const DSRCodedEntryValuegetConceptName () const
 get concept name.
 
OFCondition getConceptName (DSRCodedEntryValue &conceptName) const
 get copy of concept name.
 
OFCondition setConceptName (const DSRCodedEntryValue &conceptName)
 set concept name.
 
const OFStringgetObservationDateTime () const
 get observation date time.
 
OFCondition setObservationDateTime (const OFString &observationDateTime)
 set observation date time.
 
OFCondition getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource) const
 get template identifier and mapping resource.
 
OFCondition setTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource)
 set template identifier and mapping resource.
 

Protected Member Functions

 DSRContentItem ()
 default constructor (protected)
 
void setTreeNode (DSRDocumentTreeNode *node)
 set internal tree node pointer (protected)
 
- Protected Member Functions inherited from DSRTypes
virtual ~DSRTypes ()
 destructor.
 

Private Member Functions

 DSRContentItem (const DSRContentItem &)
 
DSRContentItemoperator= (const DSRContentItem &)
 

Private Attributes

DSRDocumentTreeNodeTreeNode
 internal tree node pointer (current conten item)
 

Static Private Attributes

static const OFString EmptyString
 empty string value. Used as default return value for getStringValue()
 
static const DSRCodedEntryValue EmptyCodedEntry
 empty coded entry value. Used as default return value for getCodeValue() and getConceptName()
 
static const
DSRNumericMeasurementValue 
EmptyNumericMeasurement
 empty numberic measurement value. Used as default return value for getNumericValue()
 
static const
DSRSpatialCoordinatesValue 
EmptySpatialCoordinates
 empty spatial coordinates value. Used as default return value for getSpatialCoordinates()
 
static const
DSRTemporalCoordinatesValue 
EmptyTemporalCoordinates
 empty temporal coordinates value. Used as default return value for getTemporalCoordinates()
 
static const
DSRCompositeReferenceValue 
EmptyCompositeReference
 empty composite reference value. Used as default return value for getCompositeReference()
 
static const DSRImageReferenceValue EmptyImageReference
 empty image reference value. Used as default return value for getImageReference()
 
static const
DSRWaveformReferenceValue 
EmptyWaveformReference
 empty waveform reference value. Used as default return value for getWaveformReference()
 

Friends

class DSRDocumentTree
 

Additional Inherited Members

- Protected Types inherited from DSRTypes
enum  E_DocumentType {
  DT_invalid, DT_unknown = DT_invalid, DT_BasicTextSR, DT_EnhancedSR,
  DT_ComprehensiveSR, DT_KeyObjectSelectionDocument, DT_MammographyCadSR, DT_ChestCadSR,
  DT_ColonCadSR, DT_ProcedureLog, DT_XRayRadiationDoseSR, DT_SpectaclePrescriptionReport,
  DT_MacularGridThicknessAndVolumeReport, DT_ImplantationPlanSRDocument, DT_last = DT_ImplantationPlanSRDocument
}
 SR document types. More...
 
enum  E_RelationshipType {
  RT_invalid, RT_unknown, RT_isRoot, RT_contains,
  RT_hasObsContext, RT_hasAcqContext, RT_hasConceptMod, RT_hasProperties,
  RT_inferredFrom, RT_selectedFrom, RT_last = RT_selectedFrom
}
 SR relationship types. More...
 
enum  E_ValueType {
  VT_invalid, VT_Text, VT_Code, VT_Num,
  VT_DateTime, VT_Date, VT_Time, VT_UIDRef,
  VT_PName, VT_SCoord, VT_SCoord3D, VT_TCoord,
  VT_Composite, VT_Image, VT_Waveform, VT_Container,
  VT_byReference, VT_last = VT_byReference
}
 SR value types. More...
 
enum  E_GraphicType {
  GT_invalid, GT_unknown = GT_invalid, GT_Point, GT_Multipoint,
  GT_Polyline, GT_Circle, GT_Ellipse, GT_last = GT_Ellipse
}
 SR graphic types. More...
 
enum  E_GraphicType3D {
  GT3_invalid, GT3_unknown = GT3_invalid, GT3_Point, GT3_Multipoint,
  GT3_Polyline, GT3_Polygon, GT3_Ellipse, GT3_Ellipsoid,
  GT3_last = GT3_Ellipsoid
}
 SR graphic types (3D). More...
 
enum  E_TemporalRangeType {
  TRT_invalid, TRT_unknown = TRT_invalid, TRT_Point, TRT_Multipoint,
  TRT_Segment, TRT_Multisegment, TRT_Begin, TRT_End,
  TRT_last = TRT_End
}
 SR temporal range types. More...
 
enum  E_ContinuityOfContent { COC_invalid, COC_Separate, COC_Continuous, COC_last = COC_Continuous }
 SR continuity of content flag. More...
 
enum  E_PreliminaryFlag { PF_invalid, PF_Preliminary, PF_Final, PF_last = PF_Final }
 SR document preliminary flag. More...
 
enum  E_CompletionFlag { CF_invalid, CF_Partial, CF_Complete, CF_last = CF_Complete }
 SR document completion flag. More...
 
enum  E_VerificationFlag { VF_invalid, VF_Unverified, VF_Verified, VF_last = VF_Verified }
 SR document verification flag. More...
 
enum  E_CharacterSet {
  CS_invalid, CS_unknown = CS_invalid, CS_ASCII, CS_Latin1,
  CS_Latin2, CS_Latin3, CS_Latin4, CS_Cyrillic,
  CS_Arabic, CS_Greek, CS_Hebrew, CS_Latin5,
  CS_Japanese, CS_Thai, CS_UTF8, CS_last = CS_UTF8
}
 Specific character set. More...
 
enum  E_AddMode { AM_afterCurrent, AM_beforeCurrent, AM_belowCurrent }
 Add node mode. More...
 
- Static Protected Member Functions inherited from DSRTypes
static const char * documentTypeToSOPClassUID (const E_DocumentType documentType)
 convert SR document type to SOP class UID
 
static const char * documentTypeToModality (const E_DocumentType documentType)
 convert SR document type to modality
 
static const char * documentTypeToReadableName (const E_DocumentType documentType)
 convert SR document type to readable name.
 
static const char * documentTypeToDocumentTitle (const E_DocumentType documentType, OFString &documentTitle)
 convert SR document type to document title.
 
static OFBool requiresEnhancedEquipmentModule (const E_DocumentType documentType)
 check whether SR document type requires Enhanced General Equipment Module
 
static const char * relationshipTypeToDefinedTerm (const E_RelationshipType relationshipType)
 convert relationship type to DICOM defined term
 
static const char * relationshipTypeToReadableName (const E_RelationshipType relationshipType)
 convert relationship type to readable name.
 
static const char * valueTypeToDefinedTerm (const E_ValueType valueType)
 convert value type to DICOM defined term
 
static const char * valueTypeToXMLTagName (const E_ValueType valueType)
 convert value type to XML tag name
 
static const char * valueTypeToReadableName (const E_ValueType valueType)
 convert value type to readable name.
 
static const char * graphicTypeToEnumeratedValue (const E_GraphicType graphicType)
 convert graphic type to DICOM enumerated value
 
static const char * graphicTypeToReadableName (const E_GraphicType graphicType)
 convert graphic type to readable name.
 
static const char * graphicType3DToEnumeratedValue (const E_GraphicType3D graphicType)
 convert graphic type (3D) to DICOM enumerated value
 
static const char * graphicType3DToReadableName (const E_GraphicType3D graphicType)
 convert graphic type (3D) to readable name.
 
static const char * temporalRangeTypeToEnumeratedValue (const E_TemporalRangeType temporalRangeType)
 convert temporal range type to DICOM enumerated value
 
static const char * temporalRangeTypeToReadableName (const E_TemporalRangeType temporalRangeType)
 convert temporal range type to readable name.
 
static const char * continuityOfContentToEnumeratedValue (const E_ContinuityOfContent continuityOfContent)
 convert continuity of content flag to DICOM enumerated value
 
static const char * preliminaryFlagToEnumeratedValue (const E_PreliminaryFlag preliminaryFlag)
 convert preliminary flag to DICOM enumerated value
 
static const char * completionFlagToEnumeratedValue (const E_CompletionFlag completionFlag)
 convert completion flag to DICOM enumerated value
 
static const char * verificationFlagToEnumeratedValue (const E_VerificationFlag verificationFlag)
 convert verification flag to DICOM enumerated value
 
static const char * characterSetToDefinedTerm (const E_CharacterSet characterSet)
 convert character set to DICOM defined term
 
static const char * characterSetToHTMLName (const E_CharacterSet characterSet)
 convert character set to HTML name.
 
static const char * characterSetToXMLName (const E_CharacterSet characterSet)
 convert character set to XML name.
 
static E_DocumentType sopClassUIDToDocumentType (const OFString &sopClassUID)
 convert SOP class UID to SR document type
 
static E_RelationshipType definedTermToRelationshipType (const OFString &definedTerm)
 convert DICOM defined term to relationship type
 
static E_ValueType definedTermToValueType (const OFString &definedTerm)
 convert DICOM defined term to value type
 
static E_ValueType xmlTagNameToValueType (const OFString &xmlTagName)
 convert XML tag name to value type
 
static E_GraphicType enumeratedValueToGraphicType (const OFString &enumeratedValue)
 convert DICOM enumerated value to graphic type
 
static E_GraphicType3D enumeratedValueToGraphicType3D (const OFString &enumeratedValue)
 convert DICOM enumerated value to graphic type (3D)
 
static E_TemporalRangeType enumeratedValueToTemporalRangeType (const OFString &enumeratedValue)
 convert DICOM enumerated value to temporal range type
 
static E_ContinuityOfContent enumeratedValueToContinuityOfContent (const OFString &enumeratedValue)
 convert DICOM enumerated value to continuity of content flag
 
static E_PreliminaryFlag enumeratedValueToPreliminaryFlag (const OFString &enumeratedValue)
 convert DICOM enumerated value to preliminary flag
 
static E_CompletionFlag enumeratedValueToCompletionFlag (const OFString &enumeratedValue)
 convert DICOM enumerated value to completion flag
 
static E_VerificationFlag enumeratedValueToVerificationFlag (const OFString &enumeratedValue)
 convert DICOM enumerated value to verification flag
 
static E_CharacterSet definedTermToCharacterSet (const OFString &definedTerm)
 convert DICOM defined term to character set
 
static OFBool isDocumentTypeSupported (const E_DocumentType documentType)
 check whether specified SR document type is supported by this library.
 
static const OFStringcurrentDate (OFString &dateString)
 get current date in DICOM 'DA' format.
 
static const OFStringcurrentTime (OFString &timeString)
 get current time in DICOM 'TM' format.
 
static const OFStringcurrentDateTime (OFString &dateTimeString)
 get current date and time in DICOM 'DT' format.
 
static const OFStringdicomToReadableDate (const OFString &dicomDate, OFString &readableDate)
 convert DICOM date string to readable format.
 
static const OFStringdicomToReadableTime (const OFString &dicomTime, OFString &readableTime)
 convert DICOM time string to readable format.
 
static const OFStringdicomToReadableDateTime (const OFString &dicomDateTime, OFString &readableDateTime)
 convert DICOM date time string to readable format.
 
static const OFStringdicomToReadablePersonName (const OFString &dicomPersonName, OFString &readablePersonName)
 convert DICOM person name to readable format.
 
static const OFStringdicomToXMLPersonName (const OFString &dicomPersonName, OFString &xmlPersonName, const OFBool writeEmptyValue=OFFalse)
 convert DICOM person name to XML format.
 
static const char * numberToString (const size_t number, char *stringValue)
 convert unsigned integer number to character string
 
static size_t stringToNumber (const char *stringValue)
 convert string to unsigned integer number
 
static const OFStringconvertToPrintString (const OFString &sourceString, OFString &printString)
 convert character string to print string.
 
static const OFStringconvertToHTMLString (const OFString &sourceString, OFString &markupString, const size_t flags=0, const OFBool newlineAllowed=OFFalse)
 convert character string to HTML mnenonic string.
 
static const OFStringconvertToXMLString (const OFString &sourceString, OFString &markupString)
 convert character string to XML mnenonic string.
 
static OFBool checkForValidUIDFormat (const OFString &stringValue)
 check string for valid UID format.
 
static DSRIODConstraintCheckercreateIODConstraintChecker (const E_DocumentType documentType)
 create specified SR IOD content relationship contraint checker object.
 
static DSRDocumentTreeNodecreateDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType)
 create specified document tree node.
 
static OFCondition addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *delem, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 add given element to the dataset.
 
static void removeAttributeFromSequence (DcmSequenceOfItems &sequence, const DcmTagKey &tagKey)
 remove given attribute from the sequence.
 
static OFCondition getElementFromDataset (DcmItem &dataset, DcmElement &delem)
 get element from dataset
 
static const char * getStringValueFromElement (const DcmElement &delem)
 get string value from element
 
static const OFStringgetStringValueFromElement (const DcmElement &delem, OFString &stringValue)
 get string value from element
 
static const OFStringgetPrintStringFromElement (const DcmElement &delem, OFString &stringValue)
 get string value from element and convert to "print" format
 
static const OFStringgetMarkupStringFromElement (const DcmElement &delem, OFString &stringValue, const OFBool convertNonASCII=OFFalse)
 get string value from element and convert to HTML/XML
 
static OFCondition getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
 get string value from dataset
 
static OFCondition putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
 put string value to dataset
 
static OFBool checkElementValue (DcmElement &delem, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
 check element value for correct value multipicity and type.
 
static OFCondition getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &delem, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 get element from dataset and check it for correct value multipicity and type.
 
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 multipicity and type.
 
static void printInvalidContentItemMessage (const char *action, const DSRDocumentTreeNode *node, const char *location=NULL)
 print the warning message that the current content item is invalid/incomplete.
 
static void printContentItemErrorMessage (const char *action, const OFCondition &result, const DSRDocumentTreeNode *node, const char *location=NULL)
 print an error message for the current content item.
 
static void printUnknownValueWarningMessage (const char *valueName, const char *readValue=NULL, const char *action="Reading")
 print a warning message that an unknown/unsupported value has been determined
 
static OFBool writeStringValueToXML (STD_NAMESPACE ostream &stream, const OFString &stringValue, const OFString &tagName, const OFBool writeEmptyValue=OFFalse)
 write string value to XML output stream.
 
static OFBool writeStringFromElementToXML (STD_NAMESPACE ostream &stream, DcmElement &delem, const OFString &tagName, const OFBool writeEmptyValue=OFFalse)
 write string value from DICOM element to XML output stream.
 
static size_t createHTMLAnnexEntry (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const OFString &referenceText, size_t &annexNumber, const size_t flags=0)
 create an HTML annex entry with hyperlinks.
 
static size_t createHTMLFootnote (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &footnoteStream, size_t &footnoteNumber, const size_t nodeID, const size_t flags=0)
 create an HTML footnote with hyperlinks
 
static OFCondition appendStream (STD_NAMESPACE ostream &mainStream, OFOStringStream &tempStream, const char *heading=NULL)
 append one output stream to another.
 
- Static Protected Attributes inherited from DSRTypes
static const size_t RF_readDigitalSignatures
 read digital signatures from dataset
 
static const size_t RF_acceptUnknownRelationshipType
 accept unknown/missing relationship type
 
static const size_t RF_ignoreRelationshipConstraints
 ignore relationship constraints for this document class
 
static const size_t RF_ignoreContentItemErrors
 do not abort on content item errors (e.g. missing value type specific attributes)
 
static const size_t RF_skipInvalidContentItems
 do not abort when detecting an invalid content item, skip invalid sub-tree instead
 
static const size_t RF_showCurrentlyProcessedItem
 show the currently processed content item (e.g. "1.2.3")
 
static const size_t HF_neverExpandChildrenInline
 external: never expand child nodes inline
 
static const size_t HF_alwaysExpandChildrenInline
 external: always expand child nodes inline
 
static const size_t HF_renderInlineCodes
 external: render codes even if they appear inline
 
static const size_t HF_useCodeDetailsTooltip
 external: render code details as a tooltip (not with HTML 3.2)
 
static const size_t HF_renderConceptNameCodes
 external: render concept name codes (default: code meaning only)
 
static const size_t HF_renderNumericUnitCodes
 external: render the code of the numeric measurement unit
 
static const size_t HF_useCodeMeaningAsUnit
 external: use code meaning for the numeric measurement unit (default: code value)
 
static const size_t HF_renderPatientTitle
 external: use patient information as document title (default: document type)
 
static const size_t HF_renderNoDocumentHeader
 external: render no general document information (header)
 
static const size_t HF_renderDcmtkFootnote
 external: render dcmtk/dcmsr comment at the end of the document
 
static const size_t HF_renderFullData
 external: render the full data of all content items
 
static const size_t HF_renderSectionTitlesInline
 external: render section titles inline (default: separate paragraph)
 
static const size_t HF_copyStyleSheetContent
 external: copy Cascading Style Sheet (CSS) content to HTML file
 
static const size_t HF_HTML32Compatibility
 external: output compatible to HTML version 3.2 (default: 4.01)
 
static const size_t HF_XHTML11Compatibility
 external: output compatible to XHTML version 1.1 (default: HTML 4.01)
 
static const size_t HF_addDocumentTypeReference
 external: add explicit reference to HTML document type (DTD)
 
static const size_t HF_omitGeneratorMetaElement
 external: omit generator meta element referring to the DCMTK
 
static const size_t HF_renderItemsSeparately
 internal: render items separately (for container with SEPARATE flag)
 
static const size_t HF_renderItemInline
 internal: expand items inline when they are short and have no child nodes
 
static const size_t HF_currentlyInsideAnnex
 internal: content item is rendered fully inside the annex
 
static const size_t HF_createFootnoteReferences
 internal: create footnote references
 
static const size_t HF_convertNonASCIICharacters
 internal: convert non-ASCII characters (> #127) to &#nnn;
 
static const size_t HF_renderAllCodes
 shortcut: render all codes
 
static const size_t HF_internalUseOnly
 shortcut: filter all flags that are only used internally
 
static const size_t XF_writeEmptyTags
 write: write all tags even if their value is empty
 
static const size_t XF_writeTemplateIdentification
 write: write template identification information (TID and mapping resource)
 
static const size_t XF_alwaysWriteItemIdentifier
 write: always write item identifier "id", not only when item is referenced
 
static const size_t XF_codeComponentsAsAttribute
 write: encode code value, coding scheme designator and coding scheme version as attribute instead of element text
 
static const size_t XF_relationshipTypeAsAttribute
 write: encode relationship type as attribute instead of element text
 
static const size_t XF_valueTypeAsAttribute
 write: encode value type as attribute instead of element text
 
static const size_t XF_templateIdentifierAsAttribute
 write: encode template identifier as attribute instead of element text
 
static const size_t XF_useDcmsrNamespace
 write: add DCMSR namespace declaration to the XML output
 
static const size_t XF_addSchemaReference
 write: add Schema reference to XML document
 
static const size_t XF_validateSchema
 read: validate content of XML document against Schema
 
static const size_t XF_templateElementEnclosesItems
 read/write: template identification element encloses content items
 
static const size_t XF_encodeEverythingAsAttribute
 shortcut: combines all XF_xxxAsAttribute write flags (see above)
 
static const size_t PF_printItemPosition
 print item position ("1.2.3") instead of line indentation
 
static const size_t PF_shortenLongItemValues
 shorten long item value (e.g. long texts)
 
static const size_t PF_printSOPInstanceUID
 print SOP instance UID of referenced objects
 
static const size_t PF_printConceptNameCodes
 print coding scheme designator/version and code value of concept names
 
static const size_t PF_printNoDocumentHeader
 print no general document information (header)
 
static const size_t PF_printTemplateIdentification
 print template identification (TID and mapping resource)
 
static const size_t PF_printAllCodes
 shortcut: print all codes
 
static const size_t CM_updatePositionString
 update the position string using the node ID
 
static const size_t CM_updateNodeID
 update the node ID using the position string
 
static const size_t CM_resetReferenceTargetFlag
 reset the reference target flag for all nodes
 

Detailed Description

Interface class for content items.

This class allows to access the document tree nodes without using any pointers.

Definition at line 56 of file dsrcitem.h.

Member Function Documentation

const DSRCodedEntryValue& DSRContentItem::getCodeValue ( ) const

get code value.

Applicable to: CODE

Returns
coded entry value of current content item if valid, EmptyCodedEntry otherwise
OFCondition DSRContentItem::getCodeValue ( DSRCodedEntryValue codeValue) const

get copy of code value.

Applicable to: CODE

Parameters
codeValuevariable where the copy should be stored
Returns
status, EC_Normal if successful, an error code otherwise
DSRCodedEntryValue* DSRContentItem::getCodeValuePtr ( )

get pointer to code value.

Applicable to: CODE

Returns
pointer to code value of current content item if valid, NULL otherwise
const DSRCompositeReferenceValue& DSRContentItem::getCompositeReference ( ) const

get composite reference.

Applicable to: COMPOSITE

Returns
reference value of current content item if valid, EmptyReference otherwise
OFCondition DSRContentItem::getCompositeReference ( DSRCompositeReferenceValue referenceValue) const

get copy of composite reference.

Applicable to: COMPOSITE

Parameters
referenceValuevariable where the copy should be stored (cleared if an error occurs)
Returns
status, EC_Normal if successful, an error code otherwise
DSRCompositeReferenceValue* DSRContentItem::getCompositeReferencePtr ( )

get pointer to composite reference.

Applicable to: COMPOSITE

Returns
pointer to reference value of current content item if valid, NULL otherwise
const DSRCodedEntryValue& DSRContentItem::getConceptName ( ) const

get concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only).

Returns
concept name value of current content item if valid, EmptyCodedEntry otherwise
OFCondition DSRContentItem::getConceptName ( DSRCodedEntryValue conceptName) const

get copy of concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only).

Parameters
conceptNamevariable where the copy should be stored (cleared if an error occurs)
Returns
status, EC_Normal if successful, an error code otherwise
DSRCodedEntryValue* DSRContentItem::getConceptNamePtr ( )

get pointer to concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only).

Returns
pointer to comcept name value of current content item if valid, NULL otherwise
E_ContinuityOfContent DSRContentItem::getContinuityOfContent ( ) const

get continuity of content flag.

This flag specifies whether or not its contained content items (child nodes) are logically linked in a continuous textual flow, or are sparate items. Applicable to: CONTAINER

Returns
continuity of content flag if successful, COC_invalid otherwise
const DSRImageReferenceValue& DSRContentItem::getImageReference ( ) const

get image reference.

Applicable to: IMAGE

Returns
image reference value of current content item if valid, EmptyImageReference otherwise
OFCondition DSRContentItem::getImageReference ( DSRImageReferenceValue referenceValue) const

get copy of image reference.

Applicable to: IMAGE

Parameters
referenceValuevariable where the copy should be stored (cleared if an error occurs)
Returns
status, EC_Normal if successful, an error code otherwise
DSRImageReferenceValue* DSRContentItem::getImageReferencePtr ( )

get pointer to image reference.

Applicable to: IMAGE

Returns
pointer to image reference value of current content item if valid, NULL otherwise
const DSRNumericMeasurementValue& DSRContentItem::getNumericValue ( ) const

get numeric value.

Applicable to: NUM

Returns
numeric measurement value of current content item if valid, EmptyNumericMeasurement otherwise
OFCondition DSRContentItem::getNumericValue ( DSRNumericMeasurementValue numericValue) const

get copy of numeric value.

Applicable to: NUM

Parameters
numericValuevariable where the copy should be stored (cleared if an error occurs)
Returns
status, EC_Normal if successful, an error code otherwise
DSRNumericMeasurementValue* DSRContentItem::getNumericValuePtr ( )

get pointer to numeric value.

Applicable to: NUM

Returns
pointer to numeric value of current content item if valid, NULL otherwise
const OFString& DSRContentItem::getObservationDateTime ( ) const

get observation date time.

This is the date and time on which this content item was completed. Might be empty if the date and time do not differ from the content date and time, see DSRDocument. Applicable to all content items (by-value only, optional attribute).

Returns
observation date and time of current content item if valid, EmptyString otherwise
size_t DSRContentItem::getReferencedNodeID ( ) const

get ID of the referenced node.

Applicable to: byReference relationships

Returns
ID of the referenced node if valid, 0 otherwise
E_RelationshipType DSRContentItem::getRelationshipType ( ) const

get relationship type.

Applicable to all content items.

Returns
relationship type of current content item if valid, RT_invalid otherwise
const DSRSpatialCoordinatesValue& DSRContentItem::getSpatialCoordinates ( ) const

get spatial coordinates.

Applicable to: SCOORD

Returns
spatial coordinates value of current content item if valid, EmptySpatialCoordinates otherwise
OFCondition DSRContentItem::getSpatialCoordinates ( DSRSpatialCoordinatesValue coordinatesValue) const

get copy of spatial coordinates.

Applicable to: SCOORD

Parameters
coordinatesValuevariable where the copy should be stored (cleared if an error occurs)
Returns
status, EC_Normal if successful, an error code otherwise
DSRSpatialCoordinatesValue* DSRContentItem::getSpatialCoordinatesPtr ( )

get pointer to spatial coordinates.

Applicable to: SCOORD

Returns
pointer to spatial coordinates value of current content item if valid, NULL otherwise
const OFString& DSRContentItem::getStringValue ( ) const

get string value.

Applicable to: TEXT, DATETIME, DATE, TIME, UIDREF, PNAME

Returns
string value of current content item if valid, EmptyString otherwise
OFCondition DSRContentItem::getTemplateIdentification ( OFString templateIdentifier,
OFString mappingResource 
) const

get template identifier and mapping resource.

This value pair identifies the template that was used to create this content item (and its children). According to the DICOM standard is is "required if a template was used to define the content of this Item, and the template consists of a single CONTAINER with nested content, and it is the outermost invocation of a set of nested templates that start with the same CONTAINER." However, this condition is currently not checked. The identification is valid if both values are either present (non-empty) or absent (empty). Applicable to all content items (by-value only, optional attribute).

Parameters
templateIdentifieridentifier of the template (might be empty)
mappingResourcemapping resource that defines the template (might be empty)
Returns
status, EC_Normal if successful, an error code otherwise
const DSRTemporalCoordinatesValue& DSRContentItem::getTemporalCoordinates ( ) const

get temporal coordinates.

Applicable to: TCOORD

Returns
temporal coordinates value of current content item if valid, EmptyTemporalCoordinates otherwise
OFCondition DSRContentItem::getTemporalCoordinates ( DSRTemporalCoordinatesValue coordinatesValue) const

get copy of temporal coordinates.

Applicable to: TCOORD

Parameters
coordinatesValuevariable where the copy should be stored (cleared if an error occurs)
Returns
status, EC_Normal if successful, an error code otherwise
DSRTemporalCoordinatesValue* DSRContentItem::getTemporalCoordinatesPtr ( )

get pointer to temporal coordinates.

Applicable to: TCOORD

Returns
pointer to temporal coordinates value of current content item if valid, NULL otherwise
E_ValueType DSRContentItem::getValueType ( ) const

get value type.

Applicable to all content items.

Returns
value type of current content item if valid, VT_invalid otherwise
const DSRWaveformReferenceValue& DSRContentItem::getWaveformReference ( ) const

get waveform reference.

Applicable to: WAVEFORM

Returns
waveform reference value of current content item if valid, EmptyWaveformReference otherwise
OFCondition DSRContentItem::getWaveformReference ( DSRWaveformReferenceValue referenceValue) const

get copy of waveform reference.

Applicable to: WAVEFORM

Parameters
referenceValuevariable where the copy should be stored (cleared if an error occurs)
Returns
status, EC_Normal if successful, an error code otherwise
DSRWaveformReferenceValue* DSRContentItem::getWaveformReferencePtr ( )

get pointer to waveform reference.

Applicable to: WAVEFORM

Returns
pointer to waveform reference value of current content item if valid, NULL otherwise
OFBool DSRContentItem::isMarked ( ) const

check for mark flag.

Applicable to all content items.

Returns
OFTrue if current content item is marked, OFFalse otherwise
OFBool DSRContentItem::isValid ( ) const

check for validity/completeness.

Applicable to all content items.

Returns
OFTrue if current content item is valid, OFFalse otherwise
OFCondition DSRContentItem::setCodeValue ( const DSRCodedEntryValue codeValue)

set code value.

Applicable to: CODE

Parameters
codeValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setCompositeReference ( const DSRCompositeReferenceValue referenceValue)

set composite reference.

Applicable to: COMPOSITE

Parameters
referenceValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setConceptName ( const DSRCodedEntryValue conceptName)

set concept name.

Code describing the concept represented by this content item. Also conveys the value of document title and section headings in documents. Applicable to all content items (by-value only, optional/conditional for some value types).

Parameters
conceptNamevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setContinuityOfContent ( const E_ContinuityOfContent  continuityOfContent)

set continuity of content flag.

This flag specifies whether or not its contained content items (child nodes) are logically linked in a continuous textual flow, or are sparate items. Applicable to: CONTAINER

Parameters
continuityOfContentvalue to be set (should be different from COC_onvalid)
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setImageReference ( const DSRImageReferenceValue referenceValue)

set image reference.

Applicable to: IMAGE

Parameters
referenceValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
void DSRContentItem::setMark ( const OFBool  flag)

mark/unmark item.

Applicable to all content items.

Parameters
flagmark item if OFTrue, unmark otherwise
OFCondition DSRContentItem::setNumericValue ( const DSRNumericMeasurementValue numericValue)

set numeric value.

Applicable to: NUM

Parameters
numericValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setObservationDateTime ( const OFString observationDateTime)

set observation date time.

This is the date and time on which this content item was completed. Might be empty if the date and time do not differ from the content date and time, see DSRDocument. Please use the correct DICOM format (VR=DT). Applicable to all content items (by-value only).

Parameters
observationDateTimevalue to be set (might be an empty string)
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setSpatialCoordinates ( const DSRSpatialCoordinatesValue coordinatesValue)

set spatial coordinates.

Applicable to: SCOORD

Parameters
coordinatesValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setStringValue ( const OFString stringValue)

set string value.

Please use the correct format for the string value depending on the corresponding content item (value type). Applicable to: TEXT, DATETIME, DATE, TIME, UIDREF, PNAME

Parameters
stringValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setTemplateIdentification ( const OFString templateIdentifier,
const OFString mappingResource 
)

set template identifier and mapping resource.

The identification is valid if both values are either present (non-empty) or absent (empty). See getTemplateIdentification() for details. Applicable to all content items (by-value only).

Parameters
templateIdentifieridentifier of the template to be set (VR=CS)
mappingResourcemapping resource that defines the template (VR=CS)
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DSRContentItem::setTemporalCoordinates ( const DSRTemporalCoordinatesValue coordinatesValue)

set temporal coordinates.

Applicable to: TCOORD

Parameters
coordinatesValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise
void DSRContentItem::setTreeNode ( DSRDocumentTreeNode node)
inlineprotected

set internal tree node pointer (protected)

Parameters
nodepointer to the document tree node (content item)

Definition at line 406 of file dsrcitem.h.

References TreeNode.

OFCondition DSRContentItem::setWaveformReference ( const DSRWaveformReferenceValue referenceValue)

set waveform reference.

Applicable to: WAVEFORM

Parameters
referenceValuevalue to be set
Returns
status, EC_Normal if successful, an error code otherwise

The documentation for this class was generated from the following file:


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2