/usr/include/dcmtk/dcmdata/dcvrsh.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 | /*
*
* Copyright (C) 1994-2017, 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: dcmdata
*
* Author: Gerd Ehlers
*
* Purpose: Interface of class DcmShortString
*
*/
#ifndef DCVRSH_H
#define DCVRSH_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dcchrstr.h"
// forward declarations
class DcmJsonFormat;
/** a class representing the DICOM value representation 'Short String' (SH)
*/
class DCMTK_DCMDATA_EXPORT DcmShortString
: public DcmCharString
{
public:
/** constructor.
* Create new element from given tag and length.
* @param tag DICOM tag for the new element
* @param len value length for the new element
*/
DcmShortString(const DcmTag &tag,
const Uint32 len = 0);
/** copy constructor
* @param old element to be copied
*/
DcmShortString(const DcmShortString &old);
/** destructor
*/
virtual ~DcmShortString();
/** assignment operator
* @param obj element to be assigned/copied
* @return reference to this object
*/
DcmShortString &operator=(const DcmShortString &obj);
/** clone method
* @return deep copy of this object
*/
virtual DcmObject *clone() const
{
return new DcmShortString(*this);
}
/** Virtual object copying. This method can be used for DcmObject
* and derived classes to get a deep copy of an object. Internally
* the assignment operator is called if the given DcmObject parameter
* is of the same type as "this" object instance. If not, an error
* is returned. This function permits copying an object by value
* in a virtual way which therefore is different to just calling the
* assignment operator of DcmElement which could result in slicing
* the object.
* @param rhs - [in] The instance to copy from. Has to be of the same
* class type as "this" object
* @return EC_Normal if copying was successful, error otherwise
*/
virtual OFCondition copyFrom(const DcmObject& rhs);
/** get element type identifier
* @return type identifier of this class (EVR_SH)
*/
virtual DcmEVR ident() const;
/** check whether stored value conforms to the VR and to the specified VM.
* Currently, the VR checker only supports ASCII (ISO_IR 6) and Latin-1 (ISO_IR 100).
* All other specific character sets disable the check of the value representation.
* @param vm value multiplicity (according to the data dictionary) to be checked for.
* (See DcmElement::checkVM() for a list of valid values.)
* @param oldFormat parameter not used for this VR (only for DA, TM)
* @return status of the check, EC_Normal if value is correct, an error code otherwise
*/
virtual OFCondition checkValue(const OFString &vm = "1-n",
const OFBool oldFormat = OFFalse);
/** get a copy of a particular string component
* @param stringVal variable in which the result value is stored
* @param pos index of the value in case of multi-valued elements (0..vm-1)
* @param normalize delete leading and trailing spaces if OFTrue
* @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getOFString(OFString &stringVal,
const unsigned long pos,
OFBool normalize = OFTrue);
/** write object in JSON format
* @param out output stream to which the JSON document is written
* @param format used to format and customize the output
* @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition writeJson(STD_NAMESPACE ostream &out,
DcmJsonFormat &format);
/* --- static helper functions --- */
/** check whether given string value conforms to the VR "SH" (Short String)
* and to the specified VM.
* @param value string value to be checked (possibly multi-valued)
* @param vm value multiplicity (according to the data dictionary) to be checked for.
* (See DcmElement::checkVM() for a list of valid values.)
* @param charset character set (according to the value of the SpecificCharacterSet
* element) to be used for checking the string value. The default is ASCII (7-bit).
* Currently, the VR checker only supports ASCII (ISO_IR 6) and Latin-1 (ISO_IR 100).
* All other values disable the check of the value representation, e.g. "UNKNOWN".
* @return status of the check, EC_Normal if value is correct, an error code otherwise
*/
static OFCondition checkStringValue(const OFString &value,
const OFString &vm = "1-n",
const OFString &charset = "");
protected:
/** @copydoc DcmCharString::getDelimiterChars()
*/
virtual const OFString& getDelimiterChars() const;
};
#endif // DCVRSH_H
|