/usr/include/dcmtk/dcmsr/dsrcodvl.h is in libdcmtk-dev 3.6.2-3build3.
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 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 | /*
*
* Copyright (C) 2000-2016, 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: DSRBasicCodedEntry, DSRCodedEntryValue
*
*/
#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/ofexbl.h"
/*----------------------*
* class declarations *
*----------------------*/
/** Class for storing the "Basic Coded Entry Attributes".
* This class should be used to define code constants since it is a lightweight structure
* that does not carry any overhead and also does not perform any unnecessary checks on the
* data passed to it. Furthermore, the individual values cannot be modified after an instance
* of this class has been constructed. Therefore, the members can be accessed publicly.
*/
class DCMTK_DCMSR_EXPORT DSRBasicCodedEntry
{
public:
/** constructor.
* To be used when the code to be set consists of three values (code value, coding scheme
* designator and code meaning).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH/UC/UR, mandatory)
* @param codingSchemeDesignator identifier of the coding scheme in which the code for
* a term is defined. (VR=SH, mandatory)
* @param codeMeaning human-readable translation of the 'codeValue'. Can be
* used for display when code dictionary is not available.
* (VR=LO, mandatory)
* @param codeValueType type of 'codeValue' (short, long or URN) used to map
* the value to the correct DICOM value representation
* (VR). The default value is the one most often used
* (DSRTypes::CVT_Short).
*/
DSRBasicCodedEntry(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codeMeaning,
const DSRTypes::E_CodeValueType codeValueType = DSRTypes::CVT_Short);
/** constructor.
* To be used when the code to be set consists of four values (code value, coding scheme
* designator, coding scheme version and code meaning).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH/UC/UR, mandatory)
* @param codingSchemeDesignator identifier of the coding scheme in which the code for
* a term is defined. (VR=SH, mandatory)
* @param codingSchemeVersion version of the coding scheme. May be used to identify
* the version of a coding scheme if necessary to resolve
* ambiguity in the 'codeValue' or 'codeMeaning'. (VR=SH,
* optional)
* @param codeMeaning human-readable translation of the 'codeValue'. Can be
* used for display when code dictionary is not available.
* (VR=LO, mandatory)
* @param codeValueType type of 'codeValue' (short, long or URN) used to map
* the value to the correct DICOM value representation
* (VR). The default value is the one most often used
* (DSRTypes::CVT_Short).
*/
DSRBasicCodedEntry(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codingSchemeVersion,
const OFString &codeMeaning,
const DSRTypes::E_CodeValueType codeValueType = DSRTypes::CVT_Short);
// --- public but constant members
/// type of 'CodeValue': short (SH), long (UC) or Uniform Resource Name (UR)
const DSRTypes::E_CodeValueType CodeValueType;
/// Code Value (VR=SH/UC/UR, type 1)
const OFString CodeValue;
/// Coding Scheme Designator (VR=SH, type 1)
const OFString CodingSchemeDesignator;
/// Coding Scheme Version (VR=SH, 1C)
const OFString CodingSchemeVersion;
/// Code Meaning (VR=LO, type 1)
const OFString CodeMeaning;
};
/** Class for handling coded entry values, i.e.\ unambiguous machine-readable codes.
* This class supports both the "Basic Coded Entry Attributes" and the "Enhanced Encoding
* Mode". There are also some basic checks that make sure that a given code is valid.
*/
class DCMTK_DCMSR_EXPORT DSRCodedEntryValue
{
// allow access to getValuePtr()
friend class DSRContentItem;
public:
/** default constructor
*/
DSRCodedEntryValue();
/** constructor.
* To be used for code constants defined by an instance of the DSRBasicCodedEntry class.
** @param basicCodedEntry code to be set, defined by its "Basic Coded Entry Attributes"
* @param check if enabled, check code for validity before setting it.
* See checkCode() for details. Empty values are never accepted.
*/
DSRCodedEntryValue(const DSRBasicCodedEntry &basicCodedEntry,
const OFBool check = OFFalse);
/** constructor.
* To be used when the code to be set consists of three values (code value, coding scheme
* designator and code meaning).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH/UC/UR, mandatory)
* @param codingSchemeDesignator identifier of the coding scheme in which the code for
* a term is defined. (VR=SH, mandatory)
* @param codeMeaning human-readable translation of the 'codeValue'. Can be
* used for display when code dictionary is not available.
* (VR=LO, mandatory)
* @param codeValueType type of 'codeValue' (short, long or URN) used to map
* the value to the correct DICOM value representation
* (VR). By default, the type is determined automatically
* (see determineCodeValueType()).
* @param check if enabled, check code for validity before setting it.
* See checkCode() for details. Empty values are never
* accepted.
*/
DSRCodedEntryValue(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codeMeaning,
const DSRTypes::E_CodeValueType codeValueType = DSRTypes::CVT_auto,
const OFExplicitBool check = OFTrue);
/** constructor.
* To be used when the code to be set consists of four values (code value, coding scheme
* designator, coding scheme version and code meaning).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH/UC/UR, mandatory)
* @param codingSchemeDesignator identifier of the coding scheme in which the code for
* a term is defined. (VR=SH, mandatory)
* @param codingSchemeVersion version of the coding scheme. May be used to identify
* the version of a coding scheme if necessary to resolve
* ambiguity in the 'codeValue' or 'codeMeaning'. (VR=SH,
* optional)
* @param codeMeaning human-readable translation of the 'codeValue'. Can be
* used for display when code dictionary is not available.
* (VR=LO, mandatory)
* @param codeValueType type of 'codeValue' (short, long or URN) used to map
* the value to the correct DICOM value representation
* (VR). By default, the type is determined automatically
* (see determineCodeValueType()).
* @param check if enabled, check code for validity before setting it.
* See checkCode() for details. Empty values are only
* accepted for non-mandatory attributes.
*/
DSRCodedEntryValue(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codingSchemeVersion,
const OFString &codeMeaning,
const DSRTypes::E_CodeValueType codeValueType = DSRTypes::CVT_auto,
const OFBool check = OFTrue);
/** 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 "equal".
* 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;
/** comparison operator "not equal".
* Two codes are not equal if either the code value or the coding scheme designator
* or the (optional) coding scheme version are not 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 not equal, OFFalse otherwise
*/
OFBool operator!=(const DSRCodedEntryValue &codedEntryValue) const;
/** comparison operator "equal".
* 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 basicCodedEntry code which should be compared to the current one
** @return OFTrue if both codes are equal, OFFalse otherwise
*/
OFBool operator==(const DSRBasicCodedEntry &basicCodedEntry) const;
/** comparison operator "not equal".
* Two codes are not equal if either the code value or the coding scheme designator
* or the (optional) coding scheme version are not equal. The code meaning is not
* relevant for this check.
** @param basicCodedEntry code which should be compared to the current one
** @return OFTrue if both codes are not equal, OFFalse otherwise
*/
OFBool operator!=(const DSRBasicCodedEntry &basicCodedEntry) 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. This check only covers the "Basic Coded Entry
* Attributes". See checkCode() for details.
** @return OFTrue if code is valid, OFFalse otherwise
*/
virtual OFBool isValid() const;
/** check whether the current code is empty, i.e.\ whether all four components of the code
* ("Basic Coded Entry Attributes") are empty.
** @return OFTrue if code is empty, OFFalse otherwise
*/
virtual OFBool isEmpty() const;
/** check whether the current code is complete, i.e.\ whether the three mandatory
* components of the code are non-empty. This is just a basic check that might be useful
* for "validating" input data. See isValid() for a more sophisticated way of checking
* the current code.
** @return OFTrue if code is complete, OFFalse otherwise
*/
virtual OFBool isComplete() 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").
* Please note that only the "Basic Coded Entry Attributes" are supported by this method.
** @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 flags flag used to customize the output (see DSRTypes::PF_xxx)
*/
void print(STD_NAMESPACE ostream &stream,
const OFBool printCodeValue = OFTrue,
const size_t flags = 0) 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 items
* than specified in the 'vm ' parameter (1 by default, which applies to most use cases).
* However, this method always reads the first item from the given sequence. If another
* item should be read (e.g. a modifier), the method readSequenceItem() should be used.
** @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.
* @param flags optional flag used to customize the reading process (see
* DSRTypes::RF_xxx)
* @param vm value multiplicity to be checked, interpreted as cardinality (number
* of items). See DcmElement::checkVM() for a list of valid values.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readSequence(DcmItem &dataset,
const DcmTagKey &tagKey,
const OFString &type,
const size_t flags = 0,
const OFString &vm = "1");
/** read code from sequence item
** @param item DICOM sequence item from which the code should be read
* @param tagKey DICOM tag specifying the sequence in which this item is contained
* @param flags flag used to customize the reading process (see DSRTypes::RF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readSequenceItem(DcmItem &item,
const DcmTagKey &tagKey,
const size_t flags = 0);
/** 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;
/** write code to sequence item
** @param item DICOM sequence item to which the code should be written
* @param tagKey DICOM tag specifying the sequence in which this item is contained
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition writeSequenceItem(DcmItem &item,
const DcmTagKey &tagKey);
/** read code from XML document.
* Please note that only the "Basic Coded Entry Attributes" are supported by this method.
** @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
*/
OFCondition readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor,
const size_t flags);
/** write code in XML format.
* Please note that only the "Basic Coded Entry Attributes" are supported by this method.
** @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.
* Please note that only the "Basic Coded Entry Attributes" are supported by this method.
** @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 the code
** @return reference to the code
*/
inline const DSRCodedEntryValue &getValue() const
{
return *this;
}
/** get copy of the code
** @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 an 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 type of code value, i.e.\ short, long or Uniform Resource Name (URN).
* The type is used to map the value to the correct DICOM value representation (VR).
** @return type of code value. Should never be DSRTypes::CVT_auto for non-empty value.
*/
inline DSRTypes::E_CodeValueType getCodeValueType() const
{
return CodeValueType;
}
/** get coding scheme designator.
* This is an identifier of the coding scheme in which the code for a term is defined.
* 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 - May be used to identify the version of a coding scheme if necessary to
* resolve ambiguity in the code value or code meaning. Coding scheme version is not
* required for backward-compatible revisions of a coding scheme.
** @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. Can be 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;
}
/** get context identifier.
* Optional - Identifier of the context group defined by a mapping resource from which
* the code was selected, or to which the code has been added as a private context group
* extension. This attribute is part of the "Enhanced Encoding Mode".
** @return current context identifier (might be invalid or an empty string)
*/
inline const OFString &getContextIdentifier() const
{
return ContextIdentifier;
}
/** get context UID.
* Optional - Uniquely identifies the context group. This attribute is part of the
* "Enhanced Encoding Mode".
** @return current context UID (might be invalid or an empty string)
*/
inline const OFString &getContextUID() const
{
return ContextUID;
}
/** get mapping resource.
* Optional - Message/Terminology mapping resource that specifies the context group with
* the given identifier. This attribute is part of the "Enhanced Encoding Mode".
** @return current mapping resource (might be invalid or an empty string)
*/
inline const OFString &getMappingResource() const
{
return MappingResource;
}
/** get context group version.
* Optional - Version of the context group. This attribute is part of the "Enhanced
* Encoding Mode".
** @return current context group version (might be invalid or an empty string)
*/
inline const OFString &getContextGroupVersion() const
{
return ContextGroupVersion;
}
/** get context group local version.
* Optional - Implementation-specific version of a context group that contains private
* extensions. This attribute is part of the "Enhanced Encoding Mode".
** @return current context group local version (might be invalid or an empty string)
*/
inline const OFString &getContextGroupLocalVersion() const
{
return ContextGroupLocalVersion;
}
/** get context group extension creator UID.
* Optional - Identifies the person or organization who created the extension to the
* context group. This attribute is part of the "Enhanced Encoding Mode".
** @return current context group extension creator UID (might be invalid or an empty
* string)
*/
inline const OFString &getContextGroupExtensionCreatorUID() const
{
return ContextGroupExtensionCreatorUID;
}
/** set code.
* Before setting the code, it is usually checked. If the code is invalid, the current
* code is not replaced and remains unchanged.
** @param codedEntryValue code to be set
* @param check if enabled, check code for validity before setting it.
* See checkCode() for details. Empty values are only accepted
* for non-mandatory attributes.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setValue(const DSRCodedEntryValue &codedEntryValue,
const OFBool check = OFTrue);
/** set code.
* To be used for code constants defined by an instance of the DSRBasicCodedEntry class.
** @param basicCodedEntry code to be set, defined by its "Basic Coded Entry Attributes"
* @param check if enabled, check code for validity before setting it.
* See checkCode() for details. Empty values are never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCode(const DSRBasicCodedEntry &basicCodedEntry,
const OFBool check = OFFalse);
/** set code.
* To be used when the code to be set consists of three values (code value, coding scheme
* designator and code meaning). The attributes from the "Enhanced Encoding Mode" are set
* by one of the setEnhancedEncodingMode() methods.
* Before setting the code, it is usually checked. 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 DSRDocument::getCodingSchemeIdentification() method
* (highly recommended for private coding schemes).
** @param codeValue identifier of the code to be set that is unambiguous
* within the coding scheme. (VR=SH/UC/UR, mandatory)
* @param codingSchemeDesignator identifier of the coding scheme in which the code for
* a term is defined. (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'. Can be
* used for display when code dictionary is not available.
* (VR=LO, mandatory)
* @param codeValueType type of 'codeValue' (short, long or URN) used to map
* the value to the correct DICOM value representation
* (VR). By default, the type is determined automatically
* (see determineCodeValueType()).
* @param check if enabled, check code for validity before setting it.
* See checkCode() for details. Empty values are only
* accepted for non-mandatory attributes.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCode(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codeMeaning,
const DSRTypes::E_CodeValueType codeValueType = DSRTypes::CVT_auto,
const OFExplicitBool check = OFTrue);
/** set code.
* To be used when the code to be set consists of four values (code value, coding scheme
* designator, coding scheme version and code meaning). The attributes from the "Enhanced
* Encoding Mode" are set by one of the setEnhancedEncodingMode() methods.
* Before setting the code, it is usually checked. 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 DSRDocument::getCodingSchemeIdentification() method
* (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 identifier of the coding scheme in which the code for
* a term is defined. (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. May be used to identify
* the version of a coding scheme if necessary to resolve
* ambiguity in the 'codeValue' or 'codeMeaning. (VR=SH,
* optional)
* @param codeMeaning human-readable translation of the 'codeValue'. Can be
* used for display when code dictionary is not available.
* (VR=LO, mandatory)
* @param codeValueType type of 'codeValue' (short, long or URN) used to map
* the value to the correct DICOM value representation
* (VR). By default, the type is determined automatically
* (see determineCodeValueType()).
* @param check if enabled, check code for validity before setting it.
* See checkCode() for details. Empty values are only
* accepted for non-mandatory attributes.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setCode(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codingSchemeVersion,
const OFString &codeMeaning,
const DSRTypes::E_CodeValueType codeValueType = DSRTypes::CVT_auto,
const OFBool check = OFTrue);
/** check whether the "Enhanced Encoding Mode" is used for this code.
* Currently, the only check that is performed is that either the context identifier or
* the context UID have a non-empty value.
** @return OFTrue if the "Enhanced Encoding Mode" is used, OFFalse otherwise
*/
OFBool usesEnhancedEncodingMode() const;
/** remove the "Enhanced Encoding Mode" from this code.
* Internally, all elements that belong to this mode are cleared.
*/
void removeEnhancedEncodingMode();
/** specify the "Enhanced Encoding Mode" for this code.
* This method should be used for private context groups, which are not identified by a
* context identifier and mapping resource. Before setting the code, it is usually
* checked. If the code is invalid, the current code is not replaced and remains
* unchanged.
** @param contextUID uniquely identifies the context group. (VR=UI, mandatory)
* @param check if enabled, the given value is checked for validity (conformance
* with corresponding VR and VM) before setting it. An empty value
* is never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setEnhancedEncodingMode(const OFString &contextUID,
const OFBool check = OFTrue);
/** specify the "Enhanced Encoding Mode" for this code.
* This method should be used for codes from or extensions to non-private context groups,
* e.g. from the DICOM Content Mapping Resource (DCMR).
** @param contextIdentifier identifier of the context group defined by
* 'mappingResource' from which the code was selected, or to
* which the code has been added as a private context group
* extension. (VR=CS, mandatory)
* @param mappingResource message/terminology mapping resource that specifies the
* context group with the given identifier. (VR=CS,
* mandatory)
* @param contextGroupVersion version of the context group. (VR=DT, mandatory)
* @param contextUID uniquely identifies the context group. (VR=UI, optional)
* @param localVersion implementation-specific version of a context group that
* contains private extensions. (VR=DT, conditional)
* @param extensionCreatorUID identifies the person or organization who created the
* extension to the context group. (VR=UI, conditional)
* Should be specified if 'localVersion' is non-empty.
* @param check if enabled, the given values are checked for validity
* (conformance with corresponding VR and VM) before setting
* them. Empty values are only accepted for non-mandatory
* attributes.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setEnhancedEncodingMode(const OFString &contextIdentifier,
const OFString &mappingResource,
const OFString &contextGroupVersion,
const OFString &contextUID = "",
const OFString &localVersion = "",
const OFString &extensionCreatorUID = "",
const OFBool check = OFTrue);
/** check the currently stored code for validity.
* See below checkCode() method for details.
** @return status, EC_Normal if current value is valid, an error code otherwise
*/
OFCondition checkCurrentValue() const;
protected:
/** get pointer to this code
** @return pointer to this code (never NULL)
*/
inline DSRCodedEntryValue *getValuePtr()
{
return this;
}
/** read code from dataset.
* This method also supports the attributes from the "Enhanced Encoding Mode".
** @param dataset DICOM dataset from which the code should be read
* @param moduleName module name (sequence) from which the item is read. If NULL,
* the default value "SR document" is used for output messages.
* @param flags flag used to customize the reading process (see DSRTypes::RF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition readItem(DcmItem &dataset,
const char *moduleName,
const size_t flags);
/** write code to dataset.
* This method also supports the attributes from the "Enhanced Encoding Mode".
** @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;
// --- static helper functions ---
/** check the specified code for validity.
* Currently, the only checks performed are that the three mandatory string values are
* non-empty and that all four values conform to the corresponding VR and VM. Later on,
* it might also be checked whether the specified code really belongs to the coding
* scheme, etc. This requires the presence of the relevant code dictionaries, though.
** @param codeValue code value to be checked
* @param codingSchemeDesignator coding scheme designator to be checked
* @param codingSchemeVersion coding scheme version to be checked (might be empty)
* @param codeMeaning code meaning to be checked
* @param codeValueType type of 'codeValue' (short, long or URN).
* Never use DSRTypes::CVT_auto for this function.
** @return status, EC_Normal if code is valid, an error code otherwise
*/
static OFCondition checkCode(const OFString &codeValue,
const OFString &codingSchemeDesignator,
const OFString &codingSchemeVersion,
const OFString &codeMeaning,
const DSRTypes::E_CodeValueType codeValueType);
/** try to determine the type of the given code value.
* Please note that the check that is currently performed is very simple. So, the user
* is advised to passed the correct type (short, long or URN) to the appropriate method
* and should not rely on this automatic detection. Specifically, URN values are only
* detected by the prefix "urn:" (i.e. no URL allowed), and the maximum length of a
* short code value is determined based on the number of bytes (not characters, since
* the character set is unknown to this function - and to this class).
** @param codeValue code value to be checked
** @return automatically determined type that should be used for the given code value
*/
static DSRTypes::E_CodeValueType determineCodeValueType(const OFString &codeValue);
private:
// -- Basic Coded Entry Attributes --
/// type of 'CodeValue': short (SH), long (UC) or Uniform Resource Name (UR)
DSRTypes::E_CodeValueType CodeValueType;
/// Code Value (VR=SH/UC/UR, type 1)
OFString CodeValue;
/// Coding Scheme Designator (VR=SH, type 1)
OFString CodingSchemeDesignator;
/// Coding Scheme Version (VR=SH, 1C)
OFString CodingSchemeVersion;
/// Code Meaning (VR=LO, type 1)
OFString CodeMeaning;
/// tbd: Equivalent Code Sequence (VR=SQ, type 3) not yet supported
// -- Enhanced Encoding Mode --
/// Context Identifier (VR=CS, type 3)
OFString ContextIdentifier;
/// Context UID (VR=UI, type 2)
OFString ContextUID;
/// Mapping Resource (VR=CS, type 1C)
OFString MappingResource;
/// Mapping Resource UID (VR=UI, type 3)
// - tbd: optional attribute not yet supported
/// Mapping Resource Name (VR=LO, type 3)
// - tbd: optional attribute not yet supported
/// Context Group Version (VR=DT, type 1C)
OFString ContextGroupVersion;
/// Context Group Local Version (VR=DT, type 1C)
OFString ContextGroupLocalVersion;
/// Context Group Extension Creator UID (VR=UI, type 1C)
OFString ContextGroupExtensionCreatorUID;
};
/** output stream operator for coded entry values.
* Internally, the DSRCodedEntryValue::print() method is used, i.e. the output looks
* like this: (1234,99_OFFIS_DCMTK,"Code Meaning") or (cm,UCUM[1.4],"centimeter")
* @param stream output stream to which the coded entry value is printed
* @param codedEntryValue coded entry value to be printed
* @return reference to output stream
*/
DCMTK_DCMSR_EXPORT STD_NAMESPACE ostream &operator<<(STD_NAMESPACE ostream &stream,
const DSRCodedEntryValue& codedEntryValue);
#endif
|