/usr/include/dcmtk/dcmdata/dcvrda.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 | /*
*
* 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, Andreas Barth, Joerg Riesmeier
*
* Purpose: Interface of class DcmDate
*
*/
#ifndef DCVRDA_H
#define DCVRDA_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dcbytstr.h"
#include "dcmtk/ofstd/ofdate.h"
/** a class representing the DICOM value representation 'Date' (DA)
*/
class DCMTK_DCMDATA_EXPORT DcmDate
: public DcmByteString
{
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
*/
DcmDate(const DcmTag &tag,
const Uint32 len = 0);
/** copy constructor
* @param old element to be copied
*/
DcmDate(const DcmDate &old);
/** destructor
*/
virtual ~DcmDate();
/** assignment operator
* @param obj element to be assigned/copied
* @return reference to this object
*/
DcmDate &operator=(const DcmDate &obj);
/** clone method
* @return deep copy of this object
*/
virtual DcmObject *clone() const
{
return new DcmDate(*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_DA)
*/
virtual DcmEVR ident() const;
/** check whether stored value conforms to the VR and to the specified VM
* @param vm value multiplicity (according to the data dictionary) to be checked for.
* (See DcmElement::checkVM() for a list of valid values.)
* @param oldFormat support old ACR/NEMA format if OFTrue ('.' as a separator)
* @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 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);
/** set the element value to the current system date.
* The DICOM DA format supported by this function is "YYYYMMDD". If the current
* system date is unavailable the date is set to "19000101" and an error code is
* returned.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition setCurrentDate();
/** set the element value to the given date
* @param dateValue date to be set (should be a valid date)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition setOFDate(const OFDate &dateValue);
/** get the current element value in OFDate format.
* Please note that the element value is expected to be in valid DICOM DA format
* ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility).
* If this function fails the result variable 'dateValue' is cleared automatically.
* @param dateValue reference to OFDate variable where the result is stored
* @param pos index of the element component in case of value multiplicity (0..vm-1)
* @param supportOldFormat if OFTrue support old (prior V3.0) date format (see above)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getOFDate(OFDate &dateValue,
const unsigned long pos = 0,
const OFBool supportOldFormat = OFTrue);
/** get the current element value in ISO date format.
* The ISO date format supported by this function is "YYYY-MM-DD". Please note
* that the element value is expected to be in valid DICOM DA format ("YYYYMMDD",
* "YYYY.MM.DD" is also supported for reasons of backward compatibility).
* If this function fails or the current element value is empty, the result
* variable 'formattedDate' is cleared automatically.
* @param formattedDate reference to string variable where the result is stored
* @param pos index of the element component in case of value multiplicity (0..vm-1)
* @param supportOldFormat if OFTrue support old (prior V3.0) date format (see above)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getISOFormattedDate(OFString &formattedDate,
const unsigned long pos = 0,
const OFBool supportOldFormat = OFTrue);
// ensure inherited overloads of matches take part in overload resolution
using DcmByteString::matches;
/// @copydoc DcmByteString::matches(OFString,OFString,OFBool)
virtual OFBool matches(const OFString& key,
const OFString& candidate,
const OFBool enableWildCardMatching = OFTrue) const;
/// @copydoc DcmElement::combinationMatches()
virtual OFBool combinationMatches(const DcmElement& keySecond,
const DcmElement& candidateFirst,
const DcmElement& candidateSecond) const;
/* --- static helper functions --- */
/** get the current system date.
* The DICOM DA format supported by this function is "YYYYMMDD". If the current
* system date is unavailable the date is set to "19000101" and an error code is
* returned.
* @param dicomDate reference to string variable where the result is stored
* @return EC_Normal upon success, an error code otherwise
*/
static OFCondition getCurrentDate(OFString &dicomDate);
/** get the specified OFDate value in DICOM format.
* The DICOM DA format supported by this function is "YYYYMMDD". If the specified
* date is invalid the date is set to "19000101" and an error code is returned.
* @param dateValue date to be converted to DICOM format
* @param dicomDate reference to string variable where the result is stored
* @return EC_Normal upon success, an error code otherwise
*/
static OFCondition getDicomDateFromOFDate(const OFDate &dateValue,
OFString &dicomDate);
/** get the specified DICOM date value in OFDate format.
* Please note that the specified value is expected to be in valid DICOM DA format
* ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility).
* If this function fails, the result variable 'dateValue' is cleared automatically.
* @param dicomDate string value in DICOM DA format to be converted to OFDate format.
* An empty string is not regarded as valid input, since the date would be unknown.
* @param dateValue reference to OFDate variable where the result is stored
* @return EC_Normal upon success, an error code otherwise
*/
static OFCondition getOFDateFromString(const OFString &dicomDate,
OFDate &dateValue);
/** get the specified DICOM date value in OFDate format.
* Please note that the specified value is expected to be in valid DICOM DA format
* ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility).
* If this function fails, the result variable 'dateValue' is cleared automatically.
* @param dicomDate string value in DICOM DA format to be converted to OFDate format.
* An empty string is not regarded as valid input, since the date would be unknown.
* @param dateValue reference to OFDate variable where the result is stored
* @param supportOldFormat set to OFFalse to disable support for old (prior V3.0) date
* format (see above).
* @return EC_Normal upon success, an error code otherwise
*/
static OFCondition getOFDateFromString(const OFString &dicomDate,
OFDate &dateValue,
const OFBool supportOldFormat);
/** get the specified DICOM date value in OFDate format.
* Please note that the specified value is expected to be in valid DICOM DA format
* ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility).
* If this function fails, the result variable 'dateValue' is cleared automatically.
* @param dicomDate string value in DICOM DA format to be converted to OFDate format.
* An empty string is not regarded as valid input, since the date would be unknown.
* @param dicomDateSize the size (in bytes) of the string 'dicomDate' refers to
* @param dateValue reference to OFDate variable where the result is stored
* @return EC_Normal upon success, an error code otherwise
*/
static OFCondition getOFDateFromString(const char *dicomDate,
const size_t dicomDateSize,
OFDate &dateValue);
/** get the specified DICOM date value in OFDate format.
* Please note that the specified value is expected to be in valid DICOM DA format
* ("YYYYMMDD", "YYYY.MM.DD" is also supported for reasons of backward compatibility).
* If this function fails, the result variable 'dateValue' is cleared automatically.
* @param dicomDate string value in DICOM DA format to be converted to OFDate format.
* An empty string is not regarded as valid input, since the date would be unknown.
* @param dicomDateSize the size (in bytes) of the string 'dicomDate' refers to
* @param dateValue reference to OFDate variable where the result is stored
* @param supportOldFormat set to OFFalse to disable support for old (prior V3.0) date
* format (see above).
* @return EC_Normal upon success, an error code otherwise
*/
static OFCondition getOFDateFromString(const char *dicomDate,
const size_t dicomDateSize,
OFDate &dateValue,
const OFBool supportOldFormat);
/** get the specified DICOM date value in ISO format.
* The ISO date format supported by this function is "YYYY-MM-DD". Please note
* that the specified value is expected to be in valid DICOM DA format ("YYYYMMDD",
* "YYYY.MM.DD" is also supported for reasons of backward compatibility).
* If this function fails or the specified DICOM date value is empty, the result
* variable 'formattedDate' is cleared automatically.
* @param dicomDate string value in DICOM DA format to be converted to ISO format
* @param formattedDate reference to string variable where the result is stored
* @param supportOldFormat if OFTrue support old (prior V3.0) date format (see above)
* @return EC_Normal upon success, an error code otherwise
*/
static OFCondition getISOFormattedDateFromString(const OFString &dicomDate,
OFString &formattedDate,
const OFBool supportOldFormat = OFTrue);
/** check whether given string value conforms to the VR "DA" (Date)
* 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 oldFormat support old ACR/NEMA date format if OFTrue (i.e. with "." delimiters)
* @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 OFBool oldFormat = OFFalse);
};
#endif // DCVRDA_H
|