DCMTK  Version 3.6.5
OFFIS DICOM Toolkit
Public Member Functions | Protected Member Functions | List of all members
DSRCompositeTreeNode Class Reference

Class for content item COMPOSITE. More...

+ Inheritance diagram for DSRCompositeTreeNode:

Public Member Functions

 DSRCompositeTreeNode (const E_RelationshipType relationshipType)
 constructor More...
 
 DSRCompositeTreeNode (const DSRCompositeTreeNode &node)
 copy constructor. More...
 
virtual ~DSRCompositeTreeNode ()
 destructor
 
virtual OFBool operator== (const DSRDocumentTreeNode &node) const
 comparison operator "equal". More...
 
virtual OFBool operator!= (const DSRDocumentTreeNode &node) const
 comparison operator "not equal". More...
 
virtual DSRCompositeTreeNodeclone () const
 clone this tree node. More...
 
virtual void clear ()
 clear all member variables. More...
 
virtual OFBool isValid () const
 check whether the content item is valid. More...
 
virtual OFBool hasValidValue () const
 check whether the value of the content item, i.e. the composite reference value, is valid More...
 
virtual OFCondition print (STD_NAMESPACE ostream &stream, const size_t flags) const
 print content item. More...
 
virtual OFCondition writeXML (STD_NAMESPACE ostream &stream, const size_t flags) const
 write content item in XML format More...
 
- Public Member Functions inherited from DSRDocumentTreeNode
 DSRDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType)
 constructor. More...
 
 DSRDocumentTreeNode (const DSRDocumentTreeNode &node)
 copy constructor. More...
 
virtual ~DSRDocumentTreeNode ()
 destructor
 
virtual OFBool isShort (const size_t flags) const
 check whether the content is short. More...
 
virtual OFBool hasTemplateIdentification () const
 check whether template identification is set More...
 
virtual OFCondition printExtended (STD_NAMESPACE ostream &stream, const size_t flags) const
 print extended information on the content item. More...
 
virtual OFCondition read (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const size_t flags)
 read content item from dataset. More...
 
virtual OFCondition write (DcmItem &dataset, DcmStack *markedItems=NULL)
 write content item to dataset. More...
 
virtual OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor, const E_DocumentType documentType, const size_t flags)
 read general XML document tree node data More...
 
virtual OFCondition renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const size_t nestingLevel, size_t &annexNumber, const size_t flags) const
 render content item in HTML/XHTML format. More...
 
OFBool isSigned ()
 check whether content item is digitally signed. More...
 
OFBool isMarked () const
 check whether content item is marked. More...
 
void setMark (const OFBool flag)
 mark/unmark the current content item. More...
 
OFBool isReferenceTarget () const
 check whether the current content item is target of a by-reference relationship More...
 
void setReferenceTarget (const OFBool isTarget=OFTrue)
 specify whether the current content item is target of a by-reference relationship More...
 
OFBool hasChildNodes () const
 check whether the current content item has any children More...
 
OFBool hasSiblingNodes () const
 check whether the current content item has any siblings More...
 
size_t getNodeID () const
 get ID of the current tree node More...
 
E_RelationshipType getRelationshipType () const
 get relationship type of the current content item More...
 
virtual OFCondition setRelationshipType (const E_RelationshipType relationshipType)
 set relationship type of the current content item (if previously unknown). More...
 
E_ValueType getValueType () const
 get value type of the current content item More...
 
const DSRCodedEntryValuegetConceptName () const
 get reference to the concept name More...
 
virtual OFCondition getConceptName (DSRCodedEntryValue &conceptName) const
 get copy of the concept name. More...
 
virtual OFCondition setConceptName (const DSRCodedEntryValue &conceptName, const OFBool check=OFTrue)
 set the concept name. More...
 
const OFStringgetObservationDateTime () const
 get observation date/time. More...
 
virtual OFCondition setObservationDateTime (const OFString &observationDateTime, const OFBool check=OFTrue)
 set observation date/time. More...
 
virtual OFCondition setObservationDateTime (const DcmElement &delem, const unsigned long pos=0, const OFBool check=OFTrue)
 set observation date/time from element. More...
 
virtual OFCondition setObservationDateTime (DcmItem &dataset, const DcmTagKey &tagKey, const unsigned long pos=0, const OFBool check=OFTrue)
 set observation date/time from dataset. More...
 
const OFStringgetObservationUID () const
 get observation unique identifier. More...
 
virtual OFCondition setObservationUID (const OFString &observationUID, const OFBool check=OFTrue)
 set observation unique identifier. More...
 
virtual OFBool compareTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="") const
 compare template identification with given values More...
 
virtual OFCondition getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource) const
 get template identifier and mapping resource. More...
 
virtual OFCondition getTemplateIdentification (OFString &templateIdentifier, OFString &mappingResource, OFString &mappingResourceUID) const
 get template identifier, mapping resource and optional mapping resource UID. More...
 
virtual OFCondition setTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID="", const OFBool check=OFTrue)
 set template identifier and mapping resource. More...
 
void removeSignatures ()
 remove digital signatures from content item. More...
 
- Public Member Functions inherited from DSRTreeNode
 DSRTreeNode (const DSRTreeNodeAnnotation &annotation=DSRTreeNodeAnnotation())
 (default) constructor More...
 
virtual ~DSRTreeNode ()
 destructor
 
DSRTreeNodegetPrev () const
 get pointer to previous tree node More...
 
DSRTreeNodegetNext () const
 get pointer to next tree node More...
 
DSRTreeNodegetDown () const
 get pointer to first child node More...
 
size_t getIdent () const
 get unique identifier of this node More...
 
OFBool hasAnnotation () const
 check whether this node has a (non-empty) annotation More...
 
void clearAnnotation ()
 clear annotation of this node
 
const DSRTreeNodeAnnotationgetAnnotation () const
 get annotation of this node (optional) More...
 
void setAnnotation (const DSRTreeNodeAnnotation &annotation)
 set annotation of this node (optional) More...
 
- Public Member Functions inherited from DSRCompositeReferenceValue
 DSRCompositeReferenceValue ()
 default constructor
 
 DSRCompositeReferenceValue (const OFString &sopClassUID, const OFString &sopInstanceUID, const OFBool check=OFTrue)
 constructor More...
 
 DSRCompositeReferenceValue (const DSRCompositeReferenceValue &referenceValue)
 copy constructor More...
 
virtual ~DSRCompositeReferenceValue ()
 destructor
 
DSRCompositeReferenceValueoperator= (const DSRCompositeReferenceValue &referenceValue)
 assignment operator More...
 
OFBool operator== (const DSRCompositeReferenceValue &referenceValue) const
 comparison operator "equal" More...
 
OFBool operator!= (const DSRCompositeReferenceValue &referenceValue) const
 comparison operator "not equal" More...
 
virtual OFBool isEmpty () const
 check whether the current reference value is empty. More...
 
virtual OFBool isComplete () const
 check whether the current reference value is complete, i.e. whether both mandatory UIDs are non-empty. More...
 
virtual OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags)
 read reference value from XML document More...
 
virtual OFCondition readSequence (DcmItem &dataset, const DcmTagKey &tagKey, const OFString &type, const size_t flags)
 read referenced SOP sequence from dataset. More...
 
virtual OFCondition writeSequence (DcmItem &dataset, const DcmTagKey &tagKey) const
 write referenced SOP sequence to dataset. More...
 
virtual OFCondition renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, size_t &annexNumber, const size_t flags) const
 render composite reference value in HTML/XHTML format More...
 
const OFStringgetSOPClassUID () const
 get SOP class UID More...
 
const OFString getSOPClassName (const OFString &defaultName="unknown SOP Class UID") const
 get name associated with the SOP class UID (if any) More...
 
const OFStringgetSOPInstanceUID () const
 get SOP instance UID More...
 
const DSRCompositeReferenceValuegetValue () const
 get reference to composite reference value More...
 
OFCondition getValue (DSRCompositeReferenceValue &referenceValue) const
 get copy of composite reference value More...
 
OFCondition setValue (const DSRCompositeReferenceValue &referenceValue, const OFBool check=OFTrue)
 set composite reference value. More...
 
OFCondition setReference (const OFString &sopClassUID, const OFString &sopInstanceUID, const OFBool check=OFTrue)
 set SOP class UID and SOP instance UID value. More...
 
OFCondition setReference (DcmItem &dataset, const OFBool check=OFTrue)
 set SOP class UID and SOP instance UID value from dataset. More...
 
OFCondition setSOPClassUID (const OFString &sopClassUID, const OFBool check=OFTrue)
 set SOP class UID value. More...
 
OFCondition setSOPClassUID (const DcmElement &delem, const unsigned long pos=0, const OFBool check=OFTrue)
 set SOP class UID value from element. More...
 
OFCondition setSOPClassUID (DcmItem &dataset, const DcmTagKey &tagKey, const unsigned long pos=0, const OFBool check=OFTrue)
 set SOP class UID value from dataset. More...
 
OFCondition setSOPInstanceUID (const OFString &sopInstanceUID, const OFBool check=OFTrue)
 set SOP instance UID value. More...
 
OFCondition setSOPInstanceUID (const DcmElement &delem, const unsigned long pos=0, const OFBool check=OFTrue)
 set SOP instance UID value from element. More...
 
OFCondition setSOPInstanceUID (DcmItem &dataset, const DcmTagKey &tagKey, const unsigned long pos=0, const OFBool check=OFTrue)
 set SOP instance UID value from dataset. More...
 

Protected Member Functions

virtual OFCondition readContentItem (DcmItem &dataset, const size_t flags)
 read content item (value) from dataset More...
 
virtual OFCondition writeContentItem (DcmItem &dataset) const
 write content item (value) to dataset More...
 
virtual OFCondition readXMLContentItem (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags)
 read content item specific XML data More...
 
virtual OFCondition renderHTMLContentItem (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const size_t nestingLevel, size_t &annexNumber, const size_t flags) const
 render content item (value) in HTML/XHTML format More...
 
- Protected Member Functions inherited from DSRDocumentTreeNode
DSRCodedEntryValuegetConceptNamePtr ()
 get pointer to the concept name More...
 
DSRDocumentTreeNodegetPrev () const
 get pointer to previous tree node More...
 
DSRDocumentTreeNodegetNext () const
 get pointer to next tree node More...
 
DSRDocumentTreeNodegetDown () const
 get pointer to first child node More...
 
size_t getIdent () const
 get unique identifier of this node More...
 
OFCondition createAndAppendNewNode (DSRDocumentTreeNode *&previousNode, const E_RelationshipType relationshipType, const E_ValueType valueType, const DSRIODConstraintChecker *constraintChecker=NULL)
 create a new node and append it to the current one More...
 
void writeXMLItemStart (STD_NAMESPACE ostream &stream, const size_t flags, const OFBool closingBracket=OFTrue) const
 write common item start (XML tag) More...
 
void writeXMLItemEnd (STD_NAMESPACE ostream &stream, const size_t flags) const
 write common item start (XML tag) More...
 
OFCondition readSRDocumentContentModule (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const size_t flags)
 read SR document content module More...
 
OFCondition writeSRDocumentContentModule (DcmItem &dataset, DcmStack *markedItems)
 write SR document content module More...
 
OFCondition readDocumentRelationshipMacro (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const OFString &posString, const size_t flags)
 read document relationship macro More...
 
OFCondition writeDocumentRelationshipMacro (DcmItem &dataset, DcmStack *markedItems)
 write document relationship macro More...
 
OFCondition readDocumentContentMacro (DcmItem &dataset, const OFString &posString, const size_t flags)
 read document content macro More...
 
OFCondition writeDocumentContentMacro (DcmItem &dataset) const
 write document content macro More...
 
OFCondition readContentSequence (DcmItem &dataset, const DSRIODConstraintChecker *constraintChecker, const OFString &posString, const size_t flags)
 read content sequence More...
 
OFCondition writeContentSequence (DcmItem &dataset, DcmStack *markedItems) const
 write content sequence More...
 
OFCondition renderHTMLConceptName (STD_NAMESPACE ostream &docStream, const size_t flags) const
 render concept name in HTML/XHTML format. More...
 
OFCondition renderHTMLChildNodes (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const size_t nestingLevel, size_t &annexNumber, const size_t flags) const
 render child nodes in HTML/XHTML format More...
 
- Protected Member Functions inherited from DSRTypes
virtual ~DSRTypes ()
 destructor. More...
 
- Protected Member Functions inherited from DSRCompositeReferenceValue
DSRCompositeReferenceValuegetValuePtr ()
 get pointer to reference value More...
 
virtual OFCondition readItem (DcmItem &dataset, const size_t flags)
 read reference value from dataset More...
 
virtual OFCondition writeItem (DcmItem &dataset) const
 write reference value to dataset More...
 
virtual OFCondition checkSOPClassUID (const OFString &sopClassUID) const
 check the specified SOP class UID for validity. More...
 
virtual OFCondition checkSOPInstanceUID (const OFString &sopInstanceUID) const
 check the specified SOP instance UID for validity. More...
 
OFCondition checkCurrentValue () const
 check the currently stored reference value for validity. More...
 

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_Comprehensive3DSR, DT_RadiopharmaceuticalRadiationDoseSR,
  DT_ExtensibleSR, DT_AcquisitionContextSR, DT_SimplifiedAdultEchoSR, DT_PatientRadiationDoseSR,
  DT_PerformedImagingAgentAdministrationSR, DT_PlannedImagingAgentAdministrationSR, DT_last = DT_PlannedImagingAgentAdministrationSR
}
 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_includedTemplate, VT_last = VT_includedTemplate
}
 SR value types. More...
 
enum  E_PresentationStateType {
  PT_invalid, PT_unknown = PT_invalid, PT_Grayscale, PT_Color,
  PT_PseudoColor, PT_Blending, PT_XAXRFGrayscale, PT_GrayscalePlanarMPR,
  PT_CompositingPlanarMPR, PT_AdvancedBlending, PT_VolumeRendering, PT_SegmentedVolumeRendering,
  PT_MultipleVolumeRendering, PT_last = PT_MultipleVolumeRendering
}
 Softcopy presentation state 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_default = CS_ASCII,
  CS_Latin1, CS_Latin2, CS_Latin3, CS_Latin4,
  CS_Cyrillic, CS_Arabic, CS_Greek, CS_Hebrew,
  CS_Latin5, CS_Thai, CS_Japanese, CS_Korean,
  CS_ChineseISO, CS_ChineseGB18030, CS_ChineseGBK, CS_UTF8,
  CS_last = CS_UTF8
}
 Specific character set. More...
 
enum  E_CodeValueType { CVT_auto, CVT_Short, CVT_Long, CVT_URN }
 Code value type. More...
 
enum  E_AddMode { AM_afterCurrent, AM_beforeCurrent, AM_belowCurrent, AM_belowCurrentBeforeFirstChild }
 Add node mode. More...
 
- Static Protected Member Functions inherited from DSRDocumentTreeNode
static const OFStringgetRelationshipText (const E_RelationshipType relationshipType, OFString &relationshipText, const size_t flags)
 convert relationship type into a text used for HTML rendering More...
 
static OFBool checkTemplateIdentification (const OFString &templateIdentifier, const OFString &mappingResource, const OFString &mappingResourceUID)
 check the specified template identification values for validity. More...
 
- Static Protected Member Functions inherited from DSRTreeNode
static size_t getIdentCounter ()
 get current value of global node counter More...
 
- Static Protected Member Functions inherited from DSRTypes
static const char * documentTypeToSOPClassUID (const E_DocumentType documentType)
 convert SR document type to SOP class UID More...
 
static const char * documentTypeToModality (const E_DocumentType documentType)
 convert SR document type to modality More...
 
static const char * documentTypeToReadableName (const E_DocumentType documentType)
 convert SR document type to readable name. More...
 
static const char * documentTypeToDocumentTitle (const E_DocumentType documentType, OFString &documentTitle)
 convert SR document type to document title. More...
 
static OFBool requiresEnhancedEquipmentModule (const E_DocumentType documentType)
 check whether SR document type requires Enhanced General Equipment Module More...
 
static OFBool requiresTimezoneModule (const E_DocumentType documentType)
 check whether SR document type requires Timezone Module More...
 
static OFBool requiresSynchronizationModule (const E_DocumentType documentType)
 check whether SR document type requires Synchronization Module More...
 
static const char * relationshipTypeToDefinedTerm (const E_RelationshipType relationshipType)
 convert relationship type to DICOM defined term More...
 
static const char * relationshipTypeToReadableName (const E_RelationshipType relationshipType)
 convert relationship type to readable name. More...
 
static const char * valueTypeToDefinedTerm (const E_ValueType valueType)
 convert value type to DICOM defined term More...
 
static const char * valueTypeToXMLTagName (const E_ValueType valueType)
 convert value type to XML tag name More...
 
static const char * valueTypeToReadableName (const E_ValueType valueType)
 convert value type to readable name. More...
 
static const char * presentationStateTypeToShortName (const E_PresentationStateType pstateType)
 convert presentation state type to short name. More...
 
static const char * graphicTypeToEnumeratedValue (const E_GraphicType graphicType)
 convert graphic type to DICOM enumerated value More...
 
static const char * graphicTypeToReadableName (const E_GraphicType graphicType)
 convert graphic type to readable name. More...
 
static const char * graphicType3DToEnumeratedValue (const E_GraphicType3D graphicType)
 convert graphic type (3D) to DICOM enumerated value More...
 
static const char * graphicType3DToReadableName (const E_GraphicType3D graphicType)
 convert graphic type (3D) to readable name. More...
 
static const char * temporalRangeTypeToEnumeratedValue (const E_TemporalRangeType temporalRangeType)
 convert temporal range type to DICOM enumerated value More...
 
static const char * temporalRangeTypeToReadableName (const E_TemporalRangeType temporalRangeType)
 convert temporal range type to readable name. More...
 
static const char * continuityOfContentToEnumeratedValue (const E_ContinuityOfContent continuityOfContent)
 convert continuity of content flag to DICOM enumerated value More...
 
static const char * preliminaryFlagToEnumeratedValue (const E_PreliminaryFlag preliminaryFlag)
 convert preliminary flag to DICOM enumerated value More...
 
static const char * completionFlagToEnumeratedValue (const E_CompletionFlag completionFlag)
 convert completion flag to DICOM enumerated value More...
 
static const char * verificationFlagToEnumeratedValue (const E_VerificationFlag verificationFlag)
 convert verification flag to DICOM enumerated value More...
 
static const char * characterSetToDefinedTerm (const E_CharacterSet characterSet)
 convert character set to DICOM defined term More...
 
static const char * characterSetToHTMLName (const E_CharacterSet characterSet)
 convert character set to HTML name. More...
 
static const char * characterSetToXMLName (const E_CharacterSet characterSet)
 convert character set to XML name. More...
 
static E_DocumentType sopClassUIDToDocumentType (const OFString &sopClassUID)
 convert SOP class UID to SR document type More...
 
static E_RelationshipType definedTermToRelationshipType (const OFString &definedTerm)
 convert DICOM defined term to relationship type More...
 
static E_ValueType definedTermToValueType (const OFString &definedTerm)
 convert DICOM defined term to value type More...
 
static E_PresentationStateType sopClassUIDToPresentationStateType (const OFString &sopClassUID)
 convert SOP class UID to presentation state type More...
 
static E_ValueType xmlTagNameToValueType (const OFString &xmlTagName)
 convert XML tag name to value type More...
 
static E_GraphicType enumeratedValueToGraphicType (const OFString &enumeratedValue)
 convert DICOM enumerated value to graphic type More...
 
static E_GraphicType3D enumeratedValueToGraphicType3D (const OFString &enumeratedValue)
 convert DICOM enumerated value to graphic type (3D) More...
 
static E_TemporalRangeType enumeratedValueToTemporalRangeType (const OFString &enumeratedValue)
 convert DICOM enumerated value to temporal range type More...
 
static E_ContinuityOfContent enumeratedValueToContinuityOfContent (const OFString &enumeratedValue)
 convert DICOM enumerated value to continuity of content flag More...
 
static E_PreliminaryFlag enumeratedValueToPreliminaryFlag (const OFString &enumeratedValue)
 convert DICOM enumerated value to preliminary flag More...
 
static E_CompletionFlag enumeratedValueToCompletionFlag (const OFString &enumeratedValue)
 convert DICOM enumerated value to completion flag More...
 
static E_VerificationFlag enumeratedValueToVerificationFlag (const OFString &enumeratedValue)
 convert DICOM enumerated value to verification flag More...
 
static E_CharacterSet definedTermToCharacterSet (const OFString &definedTerm)
 convert DICOM defined term to character set. More...
 
static OFBool isDocumentTypeSupported (const E_DocumentType documentType)
 check whether specified SR document type is supported by this library More...
 
static const OFStringcurrentDate (OFString &dateString)
 get current date in DICOM 'DA' format. More...
 
static const OFStringcurrentTime (OFString &timeString)
 get current time in DICOM 'TM' format. More...
 
static const OFStringcurrentDateTime (OFString &dateTimeString)
 get current date and time in DICOM 'DT' format. More...
 
static const OFStringlocalTimezone (OFString &timezoneString)
 get local timezone in DICOM format. More...
 
static const OFStringdicomToReadableDate (const OFString &dicomDate, OFString &readableDate)
 convert DICOM date string to readable format. More...
 
static const OFStringdicomToReadableTime (const OFString &dicomTime, OFString &readableTime)
 convert DICOM time string to readable format. More...
 
static const OFStringdicomToReadableDateTime (const OFString &dicomDateTime, OFString &readableDateTime)
 convert DICOM date time string to readable format. More...
 
static const OFStringdicomToReadablePersonName (const OFString &dicomPersonName, OFString &readablePersonName)
 convert DICOM person name to readable format. More...
 
static const OFStringdicomToXMLPersonName (const OFString &dicomPersonName, OFString &xmlPersonName, const OFBool writeEmptyValue=OFFalse)
 convert DICOM person name to XML format. More...
 
static const char * numberToString (const size_t number, char *stringValue)
 convert unsigned integer number to character string More...
 
static size_t stringToNumber (const char *stringValue)
 convert string to unsigned integer number More...
 
static const OFStringconvertToPrintString (const OFString &sourceString, OFString &printString)
 convert character string to print string. More...
 
static const OFStringconvertToHTMLString (const OFString &sourceString, OFString &markupString, const size_t flags=0, const OFBool newlineAllowed=OFFalse)
 convert character string to HTML mnenonic string. More...
 
static const OFStringconvertToXMLString (const OFString &sourceString, OFString &markupString)
 convert character string to XML mnenonic string. More...
 
static OFBool checkForValidReference (const OFString &stringValue)
 check string for valid reference (as used for by-reference relationships). More...
 
static DSRIODConstraintCheckercreateIODConstraintChecker (const E_DocumentType documentType)
 create specified SR IOD content relationship constraint checker object. More...
 
static DSRDocumentTreeNodecreateDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType)
 create specified document tree node. More...
 
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. More...
 
static void removeAttributeFromSequence (DcmSequenceOfItems &sequence, const DcmTagKey &tagKey)
 remove given attribute from the sequence. More...
 
static OFCondition getElementFromDataset (DcmItem &dataset, DcmElement &delem)
 get element from dataset More...
 
static const char * getStringValueFromElement (const DcmElement &delem)
 get string value from element More...
 
static const OFStringgetStringValueFromElement (const DcmElement &delem, OFString &stringValue)
 get string value from element. More...
 
static OFCondition getStringValueFromElement (const DcmElement &delem, OFString &stringValue, const signed long pos)
 get string value from element More...
 
static const OFStringgetPrintStringFromElement (const DcmElement &delem, OFString &stringValue)
 get string value from element and convert to "print" format. More...
 
static const OFStringgetMarkupStringFromElement (const DcmElement &delem, OFString &stringValue, const OFBool convertNonASCII=OFFalse)
 get string value from element and convert to HTML/XML. More...
 
static OFCondition getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const signed long pos=0)
 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 *delem, const DcmTagKey &tagKey, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse)
 check element value for correct value multiplicity and type. More...
 
static OFBool checkElementValue (DcmElement &delem, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse)
 check element value for correct value multiplicity and type. More...
 
static OFCondition getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &delem, const OFString &vm, const OFString &type, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse)
 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, const OFBool acceptViolation=OFFalse)
 get string value from dataset and check it for correct value multiplicity and type. More...
 
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. More...
 
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. More...
 
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 More...
 
static OFBool writeStringValueToXML (STD_NAMESPACE ostream &stream, const OFString &stringValue, const OFString &tagName, const OFBool writeEmptyValue=OFFalse)
 write string value to XML output stream. More...
 
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. More...
 
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. More...
 
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 More...
 
static OFCondition appendStream (STD_NAMESPACE ostream &mainStream, OFOStringStream &tempStream, const char *heading=NULL)
 append one output stream to another. More...
 
- Protected Attributes inherited from DSRTreeNode
DSRTreeNodePrev
 pointer to previous tree node (if any)
 
DSRTreeNodeNext
 pointer to next tree node (if any)
 
DSRTreeNodeDown
 pointer to first child node (if any)
 
DSRTreeNodeAnnotation Annotation
 annotation of the tree node (optional)
 
- Protected Attributes inherited from DSRCompositeReferenceValue
OFString SOPClassUID
 reference SOP class UID (VR=UI, type 1)
 
OFString SOPInstanceUID
 reference SOP instance UID (VR=UI, type 1)
 
- 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_acceptInvalidContentItemValue
 accept invalid content item value (e.g. violation of VR or VM definition)
 
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_addCommentsForIncludedTemplate
 write: add comments with details at beginning/end of included template (might be useful for debugging purposes)
 
static const size_t XF_acceptEmptyStudySeriesInstanceUID
 read: accept empty Study/Series/SOP Instance UID attribute values (must be filled later)
 
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_useANSIEscapeCodes
 use ANSI escape codes for output
 
static const size_t PF_printLongSOPClassName
 print long SOP class name of referenced objects (default: short name for images)
 
static const size_t PF_printSOPClassUID
 print SOP class UID of referenced objects (instead of the name)
 
static const size_t PF_printInvalidCodes
 print code triple for invalid codes (instead of the text "invalid code")
 
static const size_t PF_printNodeID
 print node ID at the beginning of each line (might be useful for debugging purposes)
 
static const size_t PF_indicateEnhancedEncodingMode
 indicate with a "*" that the "enhanced encoding mode" is used for codes
 
static const size_t PF_printAnnotation
 print annotation of a content item (optional, e.g. user-defined information)
 
static const size_t PF_hideIncludedTemplateNodes
 do not print internal "included template" nodes (position counter is still increased)
 
static const size_t PF_dontCountIncludedTemplateNodes
 do not count internal "included template" nodes (only with PF_hideIncludedTemplateNodes)
 
static const size_t PF_printEmptyCodes
 print text "empty code" for empty codes (instead of "invalid code")
 
static const size_t PF_printAllCodes
 shortcut: print all codes (combines all PF_printXxxCodes flags, see above)
 
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
 
static const size_t CB_maskPrintFlags
 bit mask (filter) for valid print flags (see PF_xxx)
 
static const size_t CB_maskReadFlags
 bit mask (filter) for valid read flags (see RF_xxx)
 

Detailed Description

Class for content item COMPOSITE.

Constructor & Destructor Documentation

◆ DSRCompositeTreeNode() [1/2]

DSRCompositeTreeNode::DSRCompositeTreeNode ( const E_RelationshipType  relationshipType)

constructor

Parameters
relationshipTypetype of relationship to the parent tree node. Should not be DSRTypes::RT_invalid or DSRTypes::RT_isRoot.

◆ DSRCompositeTreeNode() [2/2]

DSRCompositeTreeNode::DSRCompositeTreeNode ( const DSRCompositeTreeNode node)

copy constructor.

Please note that the comments on the copy constructor of the base class DSRDocumentTreeNode apply.

Parameters
nodetree node to be copied

Member Function Documentation

◆ clear()

virtual void DSRCompositeTreeNode::clear ( )
virtual

clear all member variables.

Please note that the content item might become invalid afterwards.

Reimplemented from DSRCompositeReferenceValue.

◆ clone()

virtual DSRCompositeTreeNode* DSRCompositeTreeNode::clone ( ) const
virtual

clone this tree node.

Internally, the copy constructor is used, so the corresponding comments apply.

Returns
copy of this tree node

Implements DSRDocumentTreeNode.

◆ hasValidValue()

virtual OFBool DSRCompositeTreeNode::hasValidValue ( ) const
virtual

check whether the value of the content item, i.e. the composite reference value, is valid

Returns
OFTrue if the value is valid, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

◆ isValid()

virtual OFBool DSRCompositeTreeNode::isValid ( ) const
virtual

check whether the content item is valid.

The content item is valid if the two base classes are valid. This check includes the value of the content item, which can also be checked separately with hasValidValue().

Returns
OFTrue if tree node is valid, OFFalse otherwise

Reimplemented from DSRCompositeReferenceValue.

◆ operator!=()

virtual OFBool DSRCompositeTreeNode::operator!= ( const DSRDocumentTreeNode node) const
virtual

comparison operator "not equal".

Two tree nodes are not equal if either the comparison operator of the base class DSRDocumentTreeNode regards them as "not equal" (different types or concept names) or the stored values are not equal.

Parameters
nodetree node that should be compared to the current one
Returns
OFTrue if both tree nodes are not equal, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

◆ operator==()

virtual OFBool DSRCompositeTreeNode::operator== ( const DSRDocumentTreeNode node) const
virtual

comparison operator "equal".

Two tree nodes are equal if the comparison operator of the base class DSRDocumentTreeNode regards them as "equal" (same types and concept names) and the stored values are equal.

Parameters
nodetree node that should be compared to the current one
Returns
OFTrue if both tree nodes are equal, OFFalse otherwise

Reimplemented from DSRDocumentTreeNode.

◆ print()

virtual OFCondition DSRCompositeTreeNode::print ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
virtual

print content item.

A typical output looks like this: contains COMPOSITE:=(BasicTextSR,"1.2.3")

Parameters
streamoutput stream to which the content item should be printed
flagsflag used to customize the output (see DSRTypes::PF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DSRCompositeReferenceValue.

◆ readContentItem()

virtual OFCondition DSRCompositeTreeNode::readContentItem ( DcmItem dataset,
const size_t  flags 
)
protectedvirtual

read content item (value) from dataset

Parameters
datasetDICOM dataset from which the content item should be read
flagsflag used to customize the reading process (see DSRTypes::RF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DSRDocumentTreeNode.

◆ readXMLContentItem()

virtual OFCondition DSRCompositeTreeNode::readXMLContentItem ( const DSRXMLDocument doc,
DSRXMLCursor  cursor,
const size_t  flags 
)
protectedvirtual

read content item specific XML data

Parameters
docdocument containing the XML file content
cursorcursor pointing to the starting node
flagsflag used to customize the reading process (see DSRTypes::XF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DSRDocumentTreeNode.

◆ renderHTMLContentItem()

virtual OFCondition DSRCompositeTreeNode::renderHTMLContentItem ( STD_NAMESPACE ostream &  docStream,
STD_NAMESPACE ostream &  annexStream,
const size_t  nestingLevel,
size_t &  annexNumber,
const size_t  flags 
) const
protectedvirtual

render content item (value) in HTML/XHTML format

Parameters
docStreamoutput stream to which the main HTML/XHTML document is written
annexStreamoutput stream to which the HTML/XHTML document annex is written
nestingLevelcurrent nesting level. Used to render section headings.
annexNumberreference to the variable where the current annex number is stored. Value is increased automatically by 1 after a new entry has been added.
flagsflag used to customize the output (see DSRTypes::HF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DSRDocumentTreeNode.

◆ writeContentItem()

virtual OFCondition DSRCompositeTreeNode::writeContentItem ( DcmItem dataset) const
protectedvirtual

write content item (value) to dataset

Parameters
datasetDICOM dataset to which the content item should be written
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DSRDocumentTreeNode.

◆ writeXML()

virtual OFCondition DSRCompositeTreeNode::writeXML ( STD_NAMESPACE ostream &  stream,
const size_t  flags 
) const
virtual

write content item in XML format

Parameters
streamoutput stream to which the XML document is written
flagsflag used to customize the output (see DSRTypes::XF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DSRCompositeReferenceValue.


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


Generated on Mon Oct 28 2019 for DCMTK Version 3.6.5 by Doxygen 1.8.15