/usr/include/dcmtk/dcmsr/dsrcodvl.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 427 428 429 430 431 432 433 434 435 436 | /*
*
* 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: DSRCodedEntryValue
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:32 $
* CVS/RCS Revision: $Revision: 1.21 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DSRCODVL_H
#define DSRCODVL_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmsr/dsrtypes.h"
#include "dcmtk/ofstd/ofstring.h"
/*---------------------*
* class declaration *
*---------------------*/
/** Class for coded entry values
*/
class DSRCodedEntryValue
{
// allow access to getValuePtr()
friend class DSRContentItem;
public:
/** default contructor
*/
DSRCodedEntryValue();
/** constructor.
* The code triple is only set if it passed the validity check (see setCode()).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH, mandatory)
* @param codingSchemeDesignator textual identifier of the table where the 'codeValue'
* is linked to its 'codeMeaning'. (VR=SH, mandatory)
* @param codeMeaning human-readable translation of the 'codeValue'. Used
* for display when code dictionary is not available.
* (VR=LO, mandatory)
*/
DSRCodedEntryValue(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codeMeaning);
/** constructor.
* The code 4-tuple is only set if it passed the validity check (see setCode()).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH, mandatory)
* @param codingSchemeDesignator textual identifier of the table where the 'codeValue'
* is linked to its 'codeMeaning'. (VR=SH, mandatory)
* @param codingSchemeVersion version of the coding scheme. Used when a coding
* scheme has multiple versions and the 'codingScheme
* Designator' does not explicitly (or adequately)
* specify the version number. (VR=SH, optional)
* @param codeMeaning human-readable translation of the 'codeValue'. Used
* for display when (appropriate) code dictionary is not
* available. (VR=LO, mandatory)
*/
DSRCodedEntryValue(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codingSchemeVersion,
const OFString &codeMeaning);
/** copy constructor
** @param codedEntryValue code to be copied (not checked !)
*/
DSRCodedEntryValue(const DSRCodedEntryValue &codedEntryValue);
/** destructor
*/
virtual ~DSRCodedEntryValue();
/** assignment operator
** @param codedEntryValue code to be copied (not checked !)
** @return reference to this code after 'codedEntryValue' has been copied
*/
DSRCodedEntryValue &operator=(const DSRCodedEntryValue &codedEntryValue);
/** comparison operator.
* Two codes are equal if the code value, coding scheme designator and the (optional)
* coding scheme version are equal. The code meaning is not relevant for this check.
** @param codedEntryValue code which should be compared to the current one
** @return OFTrue if both codes are equal, OFFalse otherwise
*/
OFBool operator==(const DSRCodedEntryValue &codedEntryValue) const;
/** clear all internal variables.
* Since an empty code is invalid the code becomes invalid afterwards.
*/
virtual void clear();
/** check whether the current code is valid.
* See checkCode() for details.
** @return OFTrue if code is valid, OFFalse otherwise
*/
virtual OFBool isValid() const;
/** check whether the current code is empty.
* Checks whether all four components of the code are empty.
** @return OFTrue if code is empty, OFFalse otherwise
*/
virtual OFBool isEmpty() const;
/** print code.
* The output of a typical code triple looks like this: (1234,99_OFFIS_DCMTK,"Code Meaning").
* The optional coding scheme version is printed in square brackets directly after the coding
* scheme designator, e.g.: (cm,UCUM[1.4],"centimeter")
** @param stream output stream to which the code should be printed
* @param printCodeValue flag indicating whether the code value and coding scheme
* designator should be printed (default) or not. If OFFalse the
* output looks like this: (,,"Code Meaning")
* @param printInvalid flag indicating whether the text "invalid code" should be
* printed for invalid codes or not (default)
*/
void print(STD_NAMESPACE ostream &stream,
const OFBool printCodeValue = OFTrue,
const OFBool printInvalid = OFFalse) const;
/** read code sequence from dataset.
* The number of items within the code sequence is checked. If error/warning output are
* enabled a warning message is printed if the sequence is empty or contains more than
* one item.
** @param dataset DICOM dataset from which the code sequence should be read
* @param tagKey DICOM tag specifying the attribute (= sequence) which should be read
* @param type value type of the sequence (valid value: "1", "2", something else).
* This parameter is used for checking purpose, any difference is reported.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readSequence(DcmItem &dataset,
const DcmTagKey &tagKey,
const OFString &type);
/** write code sequence to dataset
** @param dataset DICOM dataset to which the code sequence should be written
* @param tagKey DICOM tag specifying the attribute (= sequence) which should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition writeSequence(DcmItem &dataset,
const DcmTagKey &tagKey) const;
/** read code from XML document
** @param doc document containing the XML file content
* @param cursor cursor pointing to the starting node
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor);
/** write code 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) const;
/** render code in HTML/XHTML format
** @param stream output stream to which the HTML/XHTML document is written
* @param flags flag used to customize the output (see DSRTypes::HF_xxx)
* @param fullCode optional flag indicating whether to render the full code tuple
* or the code value/meaning only
* @param valueFirst optional flag indicating whether to render the code value or
* meaning first (outside the brackets)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition renderHTML(STD_NAMESPACE ostream &stream,
const size_t flags,
const OFBool fullCode = OFTrue,
const OFBool valueFirst = OFFalse) const;
/** get reference to code value
** @return reference to code value
*/
inline const DSRCodedEntryValue &getValue() const
{
return *this;
}
/** get copy of code value
** @param codedEntryValue reference to variable in which the code should be stored
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getValue(DSRCodedEntryValue &codedEntryValue) const;
/** get code value.
* This is a identifier of the code that is unambiguous within the coding scheme.
** @return current code value (might be invalid or an empty string)
*/
inline const OFString &getCodeValue() const
{
return CodeValue;
}
/** get coding scheme designator.
* This is a textual identifier of the table where the code value is linked to its
* code meaning. Designators beginning with "99" and the designator "L" are defined
* to be private or local coding schemes. More details on the coding scheme might be
* retrieved via the DSRDocument::getCodingSchemeIdentification() method.
** @return current coding scheme designator (might be invalid or an empty string)
*/
inline const OFString &getCodingSchemeDesignator() const
{
return CodingSchemeDesignator;
}
/** get coding scheme version.
* Optional - Used when a coding scheme has multiple versions and the coding scheme
* designator does not explicitly (or adequately) specify the version number.
** @return current coding scheme version (might be invalid or an empty string)
*/
inline const OFString &getCodingSchemeVersion() const
{
return CodingSchemeVersion;
}
/** get code meaning.
* Human-readable translation of the code value. Used for display when code dictionary
* is not available.
** @return current code meaning (might be invalid or an empty string)
*/
inline const OFString &getCodeMeaning() const
{
return CodeMeaning;
}
/** set code value.
* Before setting the code it is checked (see checkCode()). If the code is invalid
* the current code is not replaced and remains unchanged.
** @param codedEntryValue code to be set
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setValue(const DSRCodedEntryValue &codedEntryValue);
/** set code value.
* Before setting the code it is checked (see checkCode()). If the code is invalid
* the current code is not replaced and remains unchanged. Additional information on
* the coding scheme can be provided via the getCodingSchemeIdentification() method in
* the main interface class DSRDocument (highly recommended for private coding schemes).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH, mandatory)
* @param codingSchemeDesignator textual identifier of the table where the 'codeValue'
* is linked to its 'codeMeaning'. (VR=SH, mandatory)
* Designators beginning with "99" and the designator
* "L" are defined to be private or local coding schemes.
* @param codeMeaning human-readable translation of the 'codeValue'. Used
* for display when code dictionary is not available.
* (VR=LO, mandatory)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCode(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codeMeaning);
/** set code value.
* Before setting the specified code it is checked (see checkCode()). If the code is
* invalid the current code is not replaced and remains unchanged. Additional
* information on the coding scheme can be provided via the getCodingSchemeIdentification()
* method in the main class DSRDocument (highly recommended for private coding schemes).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH, mandatory)
* @param codingSchemeDesignator textual identifier of the table where the 'codeValue'
* is linked to its 'codeMeaning'. (VR=SH, mandatory)
* Designators beginning with "99" and the designator
* "L" are defined to be private or local coding schemes.
* @param codingSchemeVersion version of the coding scheme. Used when a coding
* scheme has multiple versions and the 'codingScheme
* Designator' does not explicitly (or adequately)
* specify the version number. (VR=SH, optional)
* @param codeMeaning human-readable translation of the 'codeValue'. Used
* for display when code dictionary is not available.
* (VR=LO, mandatory)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCode(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codingSchemeVersion,
const OFString &codeMeaning);
protected:
/** get pointer to code value
** @return pointer to code value (never NULL)
*/
inline DSRCodedEntryValue *getValuePtr()
{
return this;
}
/** read code from dataset
** @param dataset DICOM dataset from which the code should be read
* @param moduleName optional module name (sequence) from which the item is read
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readItem(DcmItem &dataset,
const char *moduleName = NULL);
/** write code to dataset
** @param dataset DICOM dataset to which the code should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition writeItem(DcmItem &dataset) const;
/** check the specified code for validity.
* Currently the only check that is performed is that the three string values are not empty.
* Later on it might be checked whether the specified code really belongs to the specified
* coding scheme, etc. This require the presence of the relevant code dictionaries.
** @param codeValue code value to be checked
* @param codingSchemeDesignator coding scheme designator to be checked
* @param codeMeaning code meaning tobe checked
** @return OFTrue if code is valid, OFFalse otherwise
*/
OFBool checkCode(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codeMeaning) const;
private:
/// code value (VR=SH, mandatory)
OFString CodeValue;
/// coding scheme designator (VR=SH, mandatory)
OFString CodingSchemeDesignator;
/// coding scheme version (VR=SH, optional)
OFString CodingSchemeVersion;
/// code meaning (VR=LO, mandatory)
OFString CodeMeaning;
};
#endif
/*
* CVS/RCS Log:
* $Log: dsrcodvl.h,v $
* Revision 1.21 2010-10-14 13:16:32 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.20 2009-10-13 14:57:50 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.19 2007-11-15 16:33:30 joergr
* Added support for output in XHTML 1.1 format.
*
* 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:04:52 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.15 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.14 2003/12/16 15:56:53 joergr
* Added note on coding scheme identfication and private coding schemes.
*
* Revision 1.13 2003/12/11 17:14:28 joergr
* Adapted documentation of print() method to new output format of CodingScheme
* Version (square brackets instead of comma to separate from CodingScheme).
*
* Revision 1.12 2003/09/10 13:16:13 joergr
* Replaced PrivateCodingSchemeUID by new CodingSchemeIdenticationSequence as
* required by CP 324.
*
* Revision 1.11 2003/08/07 17:31:00 joergr
* Removed libxml dependency from header files. Simplifies linking (MSVC).
*
* Revision 1.10 2003/08/07 12:20:48 joergr
* Added readXML functionality.
*
* Revision 1.9 2001/09/26 13:04:04 meichel
* Adapted dcmsr to class OFCondition
*
* Revision 1.8 2001/06/01 15:50:59 meichel
* Updated copyright header
*
* Revision 1.7 2000/11/09 20:32:07 joergr
* Added support for non-ASCII characters in HTML 3.2 (use numeric value).
*
* Revision 1.6 2000/11/06 11:14:55 joergr
* Updated comments/formatting.
*
* Revision 1.5 2000/11/01 16:12:55 joergr
* Added support for conversion to XML.
*
* Revision 1.4 2000/10/23 15:08:33 joergr
* Added/updated doc++ comments.
*
* Revision 1.3 2000/10/19 16:02:13 joergr
* Renamed some set methods.
* Added optional module name to read method to provide more detailed warning
* messages.
*
* Revision 1.2 2000/10/18 17:00:29 joergr
* Added methods allowing direct access to certain content item values.
* Added doc++ comments.
*
* Revision 1.1 2000/10/13 07:49:23 joergr
* Added new module 'dcmsr' providing access to DICOM structured reporting
* documents (supplement 23). Doc++ documentation not yet completed.
*
*
*/
|