/usr/include/dcmtk/dcmsr/dsrpnmtn.h is in libdcmtk-dev 3.6.1~20160216-4.
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 | /*
*
* Copyright (C) 2000-2015, 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: DSRPNameTreeNode
*
*/
#ifndef DSRPNMTN_H
#define DSRPNMTN_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmsr/dsrdoctn.h"
#include "dcmtk/dcmsr/dsrstrvl.h"
/*---------------------*
* class declaration *
*---------------------*/
/** Class for content item PNAME
*/
class DCMTK_DCMSR_EXPORT DSRPNameTreeNode
: public DSRDocumentTreeNode,
public DSRStringValue
{
public:
/** constructor
** @param relationshipType type of relationship to the parent tree node. Should
* not be DSRTypes::RT_invalid or DSRTypes::RT_isRoot.
*/
DSRPNameTreeNode(const E_RelationshipType relationshipType);
/** constructor
** @param relationshipType type of relationship to the parent tree node.
* Should not be DSRTypes::RT_invalid or DSRTypes::RT_isRoot.
* @param personNameValue initial value to be set (VR=PN, mandatory)
* @param check if enabled, check 'personNameValue' for validity before
* setting it. See checkValue() for details. An empty value
* is never accepted.
*/
DSRPNameTreeNode(const E_RelationshipType relationshipType,
const OFString &personNameValue,
const OFBool check = OFTrue);
/** copy constructor.
* Please note that the comments on the copy constructor of the base class
* DSRDocumentTreeNode apply.
** @param node tree node to be copied
*/
DSRPNameTreeNode(const DSRPNameTreeNode &node);
/** clone this tree node.
* Internally, the copy constructor is used, so the corresponding comments apply.
** @return copy of this tree node
*/
virtual DSRPNameTreeNode *clone() const;
/** destructor
*/
virtual ~DSRPNameTreeNode();
/** clear all member variables.
* Please note that the content item might become invalid afterwards.
*/
virtual void clear();
/** check whether the content item is valid.
* The content item is valid if the base classes, the concept name and the currently
* stored value (see hasValidValue()) are valid.
** @return OFTrue if tree node is valid, OFFalse otherwise
*/
virtual OFBool isValid() const;
/** check whether the value of the content item, i.e.\ the stored person name, is valid
** @return OFTrue if the value is valid, OFFalse otherwise
*/
virtual OFBool hasValidValue() const;
/** print content item.
* A typical output looks like this: contains PNAME:(,,"Code")="Riesmeier^Joerg"
** @param stream output stream to which the content item should be printed
* @param flags flag used to customize the output (see DSRTypes::PF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition print(STD_NAMESPACE ostream &stream,
const size_t flags) const;
/** write content item 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
*/
virtual OFCondition writeXML(STD_NAMESPACE ostream &stream,
const size_t flags) const;
// --- static helper function ---
/** get DICOM Person Name from XML elements.
* The five components of a DICOM Person Name (PN) are expected to be stored in the
* XML elements "prefix", "first", "middle", "last" and "suffix" as created by
* writeXML().
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
* @param nameValue reference to string object in which the value should be stored
** @return reference to string object (might be empty)
*/
static OFString &getValueFromXMLNodeContent(const DSRXMLDocument &doc,
DSRXMLCursor cursor,
OFString &nameValue);
protected:
/** read content item (value) from dataset
** @param dataset DICOM dataset from which the content item should be read
* @param flags flag used to customize the reading process (see DSRTypes::RF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition readContentItem(DcmItem &dataset,
const size_t flags);
/** write content item (value) to dataset
** @param dataset DICOM dataset to which the content item should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition writeContentItem(DcmItem &dataset) const;
/** read content item specific XML data
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
* @param flags flag used to customize the reading process (see DSRTypes::XF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition readXMLContentItem(const DSRXMLDocument &doc,
DSRXMLCursor cursor,
const size_t flags);
/** render content item (value) 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 nestingLevel current nesting level. Used to render section headings.
* @param annexNumber reference to the variable where the current annex number is stored.
* Value is increased automatically by 1 after a new entry has been added.
* @param flags flag used to customize the output (see DSRTypes::HF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition renderHTMLContentItem(STD_NAMESPACE ostream &docStream,
STD_NAMESPACE ostream &annexStream,
const size_t nestingLevel,
size_t &annexNumber,
const size_t flags) const;
/** check the specified person name value for validity.
* In addition to the base class check for a non-empty value, this method also checks
* whether the given value conforms to the corresponding VR (PN) and VM (1).
** @param personNameValue value to be checked
** @return status, EC_Normal if value is valid, an error code otherwise
*/
virtual OFCondition checkValue(const OFString &personNameValue) const;
private:
// --- declaration of default constructor and assignment operator
DSRPNameTreeNode();
DSRPNameTreeNode &operator=(const DSRPNameTreeNode &);
};
#endif
|