/usr/include/dcmtk/dcmsr/dsrdoctr.h is in libdcmtk2-dev 3.6.0-15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 | /*
*
* Copyright (C) 2000-2010, OFFIS e.V.
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation were developed by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmsr
*
* Author: Joerg Riesmeier
*
* Purpose:
* classes: DSRDocumentTree
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:32 $
* CVS/RCS Revision: $Revision: 1.23 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DSRDOCTR_H
#define DSRDOCTR_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmsr/dsrtree.h"
#include "dcmtk/dcmsr/dsrdoctn.h"
#include "dcmtk/dcmsr/dsrcitem.h"
#include "dcmtk/dcmdata/dcitem.h"
/*-----------------------*
* forward declaration *
*-----------------------*/
class DSRIODConstraintChecker;
/*---------------------*
* class declaration *
*---------------------*/
/** Class managing the SR document tree
*/
class DSRDocumentTree
: public DSRTree
{
public:
/** constructor
** @param documentType document type of the associated document
*/
DSRDocumentTree(const E_DocumentType documentType);
/** destructor
*/
virtual ~DSRDocumentTree();
/** clear internal member variables.
* The document type is not changed (e.g. set to DT_invalid).
*/
virtual void clear();
/** check whether the current internal state is valid.
* The SR document is valid if the document type is supported, the tree is not
* empty the root item is a container and has the internal relationship type
* RT_isRoot.
** @return OFTrue if valid, OFFalse otherwise
*/
virtual OFBool isValid() const;
/** print current SR document tree to specified output stream
** @param stream output stream
* @param flags flag used to customize the output (see DSRTypes::PF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition print(STD_NAMESPACE ostream &stream,
const size_t flags = 0);
/** read SR document tree from DICOM dataset.
* Please note that the current document tree is also deleted if the reading fails.
* If the log stream is set and valid the reason for any error might be obtained
* from the error/warning output.
** @param dataset reference to DICOM dataset where the tree should be read from
* @param documentType document type of the SR document from which the tree is read
* @param flags flag used to customize the reading process (see DSRTypes::RF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition read(DcmItem &dataset,
const E_DocumentType documentType,
const size_t flags = 0);
/** write current SR document tree to DICOM dataset
** @param dataset reference to DICOM dataset where the current tree should be
* written to
* @param markedItems optional stack where pointers to all 'marked' content items
* (DICOM datasets/items) are added to during the write process.
* Can be used to digitally sign parts of the document tree.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition write(DcmItem &dataset,
DcmStack *markedItems = NULL);
/** read XML document tree
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
* @param flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor,
const size_t flags);
/** write current SR document tree in XML format
** @param stream output stream to which the XML document is written
* @param flags flag used to customize the output (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition writeXML(STD_NAMESPACE ostream &stream,
const size_t flags);
/** render current SR document tree in HTML/XHTML format
** @param docStream output stream to which the main HTML/XHTML document is written
* @param annexStream output stream to which the HTML/XHTML document annex is written
* @param flags flag used to customize the output (see DSRTypes::HF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition renderHTML(STD_NAMESPACE ostream &docStream,
STD_NAMESPACE ostream &annexStream,
const size_t flags = 0);
/** get document type
** return current document type (might be DT_invalid)
*/
E_DocumentType getDocumentType() const
{
return DocumentType;
}
/** change document type.
* Please note that the document tree is deleted if the specified 'documentType'
* is supported. Otherwise the current document remains in force.
** @param documentType new document type to be set (should be != DT_invalid)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition changeDocumentType(const E_DocumentType documentType);
/** check whether specified content item can be added to the current one.
* If the tree is currently empty only a CONTAINER with the internal relationship
* type RT_isRoot is allowed (as the new root node). Always returns true if no
* constraint checker is available. This method can be used to decide which type
* of content items can be added prior to really do so.
** @param relationshipType relationship type of node to be checked with regard
* to the current one
* @param valueType value type of node to be checked
* @param addMode flag specifying at which position the new node would
* be added.
* (AM_afterCurrent, AM_beforeCurrent, AM_belowCurrent)
** @return OFTrue if specified node can be added, OFFalse otherwise
*/
OFBool canAddContentItem(const E_RelationshipType relationshipType,
const E_ValueType valueType,
const E_AddMode addMode = AM_afterCurrent);
/** check whether specified by-reference relationship can be added to the current
* content item. Always returns true if no constraint checker is available.
** @param relationshipType type of relationship between current and target node
* @param targetValueType value type of the referenced target node
** @return OFTrue if specified by-reference relationship can be added, OFFalse otherwise
*/
OFBool canAddByReferenceRelationship(const E_RelationshipType relationshipType,
const E_ValueType targetValueType);
/** add specified content item to the current one.
* If possible this method creates a new node as specified and adds it to the current
* one. The method canAddContentItem() is called internally to check parameters first.
** @param relationshipType relationship type of node to be added with regard
* to the current one
* @param valueType value type of node to be added
* @param addMode flag specifying at which position to add the new node.
* (AM_afterCurrent, AM_beforeCurrent, AM_belowCurrent)
** @return ID of new node if successful, 0 otherwise
*/
size_t addContentItem(const E_RelationshipType relationshipType,
const E_ValueType valueType,
const E_AddMode addMode = AM_afterCurrent);
/** add specified by-reference relationship to the current content item.
* If possible this method creates a new pseudo-node (relationship) and adds it to the
* current one. The method canAddByReferenceRelationship() is called internally to check
* parameters first. The internal cursor is automatically re-set to the current node.
** @param relationshipType relationship type between current and referenced node
* @param referencedNodeID node ID of the referenced content item
** @return ID of new pseudo-node if successful, 0 otherwise
*/
size_t addByReferenceRelationship(const E_RelationshipType relationshipType,
const size_t referencedNodeID);
/** remove current content item from tree.
* Please note that not only the specified node but also all of its child nodes are
* removed from the tree and then deleted. The internal cursor is set automatically
* to a new valid position.
** @return ID of the node which became the current one after deletion, 0 if an error
* occured or the tree is now empty.
*/
size_t removeCurrentContentItem();
/** get reference to current content item.
* This mechanism allows to access all content items without using pointers.
** @return reference to current content item (might be invalid)
*/
DSRContentItem &getCurrentContentItem();
/** set internal cursor to the named node.
* If more than one node exists with the given concept name the first one will
* be selected. Use gotoNextNamedNode() in order to go to the next matching node.
** @param conceptName concept name of the node to be searched for
* @param startFromRoot flag indicating whether to start from the root node
* or the current one
* @param searchIntoSub flag indicating whether to search into sub-trees
* ("deep search") or on the current level only
** @return ID of the new current node if successful, 0 otherwise
*/
size_t gotoNamedNode(const DSRCodedEntryValue &conceptName,
const OFBool startFromRoot = OFTrue,
const OFBool searchIntoSub = OFTrue);
/** set internal cursor to the next named node.
* Starts from "next" node, i.e. either the first children of the current node
* or the first sibling following the current node.
** @param conceptName concept name of the node to be searched for
* @param searchIntoSub flag indicating whether to search into sub-trees
* ("deep search") or on the current level only
** @return ID of the new current node if successful, 0 otherwise
*/
size_t gotoNextNamedNode(const DSRCodedEntryValue &conceptName,
const OFBool searchIntoSub = OFTrue);
/** unmark all content items in the document tree.
* Use method 'setMark' on node-level to mark and unmark a single content item.
* Pointers to the DICOM dataset/item of marked content items are added to the optional
* stack when calling the 'write' method. This mechanism can e.g. be used to digitally
* sign particular content items.
*/
void unmarkAllContentItems();
/** remove digital signatures from the document tree.
* This method clears the MACParametersSequence and the DigitalSignaturesSequence for
* all content items which have been filled during reading.
*/
void removeSignatures();
protected:
/** add new node to the current one.
* Please note that no copy of the given node is created. Therefore, the node
* should be created with new() - do not use a reference to a local variable.
* If the node could be added successfully the cursor is set to it automatically.
** @param node pointer to the new node to be added
* @param addMode flag specifying at which position to add the new node.
* (AM_afterCurrent, AM_beforeCurrent, AM_belowCurrent)
** @return ID of the new added node if successful, 0 otherwise
*/
virtual size_t addNode(DSRDocumentTreeNode *node,
const E_AddMode addMode = AM_afterCurrent);
/** remove current node from tree.
* Please note that not only the specified node but also all of his child nodes are
* removed from the tree and deleted afterwards. The cursor is set automatically to
* a new valid position.
** @return ID of the node which became the current one after deletion, 0 if an error
* occured or the tree is now empty.
*/
virtual size_t removeNode();
/** check the by-reference relationships (if any) for validity.
* This function checks whether all by-reference relationships possibly contained
* in the document tree are valid according to the following restrictions: source
* and target node are not identical and the target node is not an ancestor of the
* source node (requirement from the DICOM standard to prevent loops -> directed
* acyclic graph, though this is not 100% true - see "reportlp.dcm" example).
* In addition, the position strings (used to encode by-reference relationships
* according to the DICOM standard) OR the node IDs (used internally to uniquely
* identify nodes) can be updated. Please note that the modes 'CM_updatePositionString'
* and 'CM_updateNodeID' are mutually exclusive.
** @param mode mode used to customize the checking process (see DSRTypes::CM_xxx)
* @param flags flag used to customize the reading process (see DSRTypes::RF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition checkByReferenceRelationships(const size_t mode = 0,
const size_t flags = 0);
/** reset flag for all content items whether they are target of a by-reference relationship.
* This function calls 'setReferenceTarget(OFFalse)' for all content items.
*/
void resetReferenceTargetFlag();
private:
/** add new node to the current one.
* This method just overwrites the method from the base class DSRTree. Use the
* above addNode() method instead.
** @param node dummy parameter
* @param addMode dummy parameter
** @return always 0 (invalid)
*/
virtual size_t addNode(DSRTreeNode *node,
const E_AddMode addMode = AM_afterCurrent);
/// document type of the associated SR document
E_DocumentType DocumentType;
/// current content item. Introduced to avoid the external use of pointers.
DSRContentItem CurrentContentItem;
/// check relationship content constraints of the associated IOD
DSRIODConstraintChecker *ConstraintChecker;
// --- declaration of default/copy constructor and assignment operator
DSRDocumentTree();
DSRDocumentTree(const DSRDocumentTree &);
DSRDocumentTree &operator=(const DSRDocumentTree &);
};
#endif
/*
* CVS/RCS Log:
* $Log: dsrdoctr.h,v $
* Revision 1.23 2010-10-14 13:16:32 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.22 2009-10-13 14:57:50 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.21 2008-05-19 09:46:40 joergr
* Reset flag for all content items whether they are target of a by-reference
* relationship (required for an reproducible behavior).
* Changed parameters of checkByReferenceRelationships() method.
*
* Revision 1.20 2007/11/15 16:33:30 joergr
* Added support for output in XHTML 1.1 format.
*
* Revision 1.19 2007/05/11 14:50:05 joergr
* Enhanced debug output when detecting by-reference relationships to non-
* existing content items.
*
* Revision 1.18 2006/08/15 16:40:03 meichel
* Updated the code in module dcmsr to correctly compile when
* all standard C++ classes remain in namespace std.
*
* Revision 1.17 2006/05/11 09:18:21 joergr
* Moved containsExtendedCharacters() from dcmsr to dcmdata module.
*
* Revision 1.16 2005/12/08 16:05:01 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.15 2005/07/27 16:36:38 joergr
* Added methods that allow to go to a named node, i.e. using a given concept
* name.
*
* Revision 1.14 2004/11/22 16:39:09 meichel
* Added method that checks if the SR document contains non-ASCII characters
* in any of the strings affected by SpecificCharacterSet.
*
* Revision 1.13 2003/09/15 14:18:54 joergr
* Introduced new class to facilitate checking of SR IOD relationship content
* constraints. Replaced old implementation distributed over numerous classes.
*
* Revision 1.12 2003/08/07 12:35:27 joergr
* Added readXML functionality.
* Updated documentation to get rid of doxygen warnings.
*
* Revision 1.11 2002/04/11 13:02:34 joergr
* Corrected typo and/or enhanced documentation.
*
* Revision 1.10 2001/11/09 16:10:49 joergr
* Added preliminary support for Mammography CAD SR.
*
* Revision 1.9 2001/09/26 13:04:07 meichel
* Adapted dcmsr to class OFCondition
*
* Revision 1.8 2001/04/03 08:24:01 joergr
* Added new command line option: ignore relationship content constraints
* specified for each SR document class.
*
* Revision 1.7 2001/01/25 11:48:43 joergr
* Corrected typos / enhanced comments.
*
* Revision 1.6 2001/01/18 15:53:34 joergr
* Added support for digital signatures.
*
* Revision 1.5 2000/11/07 18:14:29 joergr
* Enhanced support for by-reference relationships.
*
* Revision 1.4 2000/11/01 16:23:20 joergr
* Added support for conversion to XML.
*
* Revision 1.3 2000/10/18 17:02:57 joergr
* Added doc++ comments.
*
* Revision 1.2 2000/10/16 16:31:45 joergr
* Added doc++ comments.
*
* Revision 1.1 2000/10/13 07:49:26 joergr
* Added new module 'dcmsr' providing access to DICOM structured reporting
* documents (supplement 23). Doc++ documentation not yet completed.
*
*
*/
|