/usr/include/dcmtk/dcmsr/dsrcomvl.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 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 | /*
*
* 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: DSRCompositeReferenceValue
*
*/
#ifndef DSRCOMVL_H
#define DSRCOMVL_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 composite reference values
*/
class DCMTK_DCMSR_EXPORT DSRCompositeReferenceValue
{
// allow access to getValuePtr()
friend class DSRContentItem;
public:
/** default constructor
*/
DSRCompositeReferenceValue();
/** constructor
** @param sopClassUID referenced SOP class UID of the composite object.
* (VR=UI, mandatory)
* @param sopInstanceUID referenced SOP instance UID of the composite object.
* (VR=UI, mandatory)
* @param check if enabled, check 'sopClassUID' and 'sopInstanceUID' for
* validity before setting them. See checkXXX() for details.
* Empty values are never accepted.
*/
DSRCompositeReferenceValue(const OFString &sopClassUID,
const OFString &sopInstanceUID,
const OFBool check = OFTrue);
/** copy constructor
** @param referenceValue reference value to be copied (not checked !)
*/
DSRCompositeReferenceValue(const DSRCompositeReferenceValue &referenceValue);
/** destructor
*/
virtual ~DSRCompositeReferenceValue();
/** assignment operator
** @param referenceValue reference value to be copied (not checked !)
** @return reference to this reference value after 'referenceValue' has been copied
*/
DSRCompositeReferenceValue &operator=(const DSRCompositeReferenceValue &referenceValue);
/** clear all internal variables.
* Since an empty reference value is invalid the reference becomes invalid afterwards.
*/
virtual void clear();
/** check whether the current reference value is valid.
* The reference value is valid if SOP class UID and SOP instance UID are valid. See
* checkSOPClassUID() and checkSOPInstanceUID() methods for details.
** @return OFTrue if reference value is valid, OFFalse otherwise
*/
virtual OFBool isValid() const;
/** check whether the current reference value is empty.
* Checks whether both mandatory UIDs of the reference value are empty.
** @return OFTrue if value is empty, OFFalse otherwise
*/
virtual OFBool isEmpty() const;
/** check whether the current reference value is complete, i.e.\ whether both
* mandatory UIDs 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 reference value.
** @return OFTrue if value is complete, OFFalse otherwise
*/
virtual OFBool isComplete() const;
/** print reference value.
* The output of a typical composite reference value looks like this: (BasicTextSR,"1.2.3").
* If the SOP class UID is unknown, the UID is printed instead of the related name.
** @param stream output stream to which the reference value 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;
/** read reference value from XML document
** @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 readXML(const DSRXMLDocument &doc,
DSRXMLCursor cursor,
const size_t flags);
/** write reference value 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;
/** read referenced SOP sequence from dataset.
* The number of items within the sequence is checked. If error/warning output are
* enabled, a warning message is printed if the sequence is absent or contains more than
* one item.
** @param dataset DICOM dataset from which the 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 flag used to customize the reading process (see DSRTypes::RF_xxx)
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition readSequence(DcmItem &dataset,
const DcmTagKey &tagKey,
const OFString &type,
const size_t flags);
/** write referenced SOP sequence to dataset.
* If the value is empty an empty sequence (without any items) is written.
** @param dataset DICOM dataset to which the 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
*/
virtual OFCondition writeSequence(DcmItem &dataset,
const DcmTagKey &tagKey) const;
/** render composite reference 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 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 renderHTML(STD_NAMESPACE ostream &docStream,
STD_NAMESPACE ostream &annexStream,
size_t &annexNumber,
const size_t flags) const;
/** get SOP class UID
** @return current SOP class UID (might be invalid or an empty string)
*/
inline const OFString &getSOPClassUID() const
{
return SOPClassUID;
}
/** get name associated with the SOP class UID (if any)
** @param defaultName string value that is returned if the SOP class UID is unknown
** @return name associated with the current SOP class UID (might be empty, e.g. in case
* the SOP class UID is empty or 'defaultName' is an empty string)
*/
const OFString getSOPClassName(const OFString &defaultName = "unknown SOP Class UID") const;
/** get SOP instance UID
** @return current SOP instance UID (might be invalid or an empty string)
*/
inline const OFString &getSOPInstanceUID() const
{
return SOPInstanceUID;
}
/** get reference to composite reference value
** @return reference to composite reference value
*/
inline const DSRCompositeReferenceValue &getValue() const
{
return *this;
}
/** get copy of composite reference value
** @param referenceValue reference to variable in which the value should be stored
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition getValue(DSRCompositeReferenceValue &referenceValue) const;
/** set composite reference value.
* Before setting the reference, it is usually checked. If the value is invalid, the
* current value is not replaced and remains unchanged.
** @param referenceValue value to be set
* @param check if enabled, check value for validity before setting it.
* See checkXXX() for details. Empty values are never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setValue(const DSRCompositeReferenceValue &referenceValue,
const OFBool check = OFTrue);
/** set SOP class UID and SOP instance UID value.
* Before setting the values, they are usually checked. If the value pair is invalid
* the current value pair is not replaced and remains unchanged.
** @param sopClassUID referenced SOP class UID to be set. (VR=UI, mandatory)
* @param sopInstanceUID referenced SOP instance UID to be set. (VR=UI, mandatory)
* @param check if enabled, check 'sopClassUID' and 'sopInstanceUID' for
* validity before setting them. See checkXXX() for details.
* Empty values are never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setReference(const OFString &sopClassUID,
const OFString &sopInstanceUID,
const OFBool check = OFTrue);
/** set SOP class UID and SOP instance UID value from dataset.
* Internally, the methods setSOPClassUID() and setSOPInstanceUID() are called with the
* given 'dataset' and the tags DCM_SOPClassUID and DCM_SOPInstanceUID, respectively.
* I.e., the SOP class UID might be set even if the SOP instance UID value is invalid.
** @param dataset DICOM dataset from which the UID values should be retrieved
* @param check if enabled, check retrieved UID values for validity before setting
* them. See checkXXX() for details. Empty values are never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setReference(DcmItem &dataset,
const OFBool check = OFTrue);
/** set SOP class UID value.
* Before setting the value, it is usually checked. If the value is invalid, the current
* value is not replaced and remains unchanged.
** @param sopClassUID SOP class UID to be set
* @param check if enabled, check 'sopClassUID' for validity before setting it.
* See checkSOPClassUID() for details. Am empty value is never
* accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setSOPClassUID(const OFString &sopClassUID,
const OFBool check = OFTrue);
/** set SOP class UID value from element.
* Before setting the value, it is usually checked. If the value is invalid, the current
* value is not replaced and remains unchanged.
** @param delem DICOM element from which the UID value should be retrieved
* @param pos index of the value in case of multi-valued elements (0..vm-1)
* @param check if enabled, check UID value for validity before setting it. See
* checkSOPClassUID() for details. An empty value is never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setSOPClassUID(const DcmElement &delem,
const unsigned long pos = 0,
const OFBool check = OFTrue);
/** set SOP class UID value from dataset.
* Before setting the value, it is usually checked. If the value is invalid, the current
* value is not replaced and remains unchanged.
** @param dataset DICOM dataset from which the UID value should be retrieved
* @param tagKey DICOM tag specifying the attribute from which the value should be
* retrieved. The search is limited to the top-level of the dataset.
* @param pos index of the value in case of multi-valued elements (0..vm-1)
* @param check if enabled, check UID value for validity before setting it. See
* checkSOPClassUID() for details. An empty value is never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setSOPClassUID(DcmItem &dataset,
const DcmTagKey &tagKey,
const unsigned long pos = 0,
const OFBool check = OFTrue);
/** set SOP instance UID value.
* Before setting the value, it is usually checked. If the value is invalid, the current
* value is not replaced and remains unchanged.
** @param sopInstanceUID SOP instance UID to be set
* @param check if enabled, check 'sopInstanceUID' for validity before setting
* it. See checkSOPInstanceUID() for details. An empty value is
* never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setSOPInstanceUID(const OFString &sopInstanceUID,
const OFBool check = OFTrue);
/** set SOP instance UID value from element.
* Before setting the value, it is usually checked. If the value is invalid, the current
* value is not replaced and remains unchanged.
** @param delem DICOM element from which the UID value should be retrieved
* @param pos index of the value in case of multi-valued elements (0..vm-1)
* @param check if enabled, check UID value for validity before setting it. See
* checkSOPInstanceUID() for details. An empty value is never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setSOPInstanceUID(const DcmElement &delem,
const unsigned long pos = 0,
const OFBool check = OFTrue);
/** set SOP instance UID value from dataset.
* Before setting the value, it is usually checked. If the value is invalid, the current
* value is not replaced and remains unchanged.
** @param dataset DICOM dataset from which the UID value should be retrieved
* @param tagKey DICOM tag specifying the attribute from which the value should be
* retrieved. The search is limited to the top-level of the dataset.
* @param pos index of the value in case of multi-valued elements (0..vm-1)
* @param check if enabled, check UID value for validity before setting it. See
* checkSOPInstanceUID() for details. An empty value is never accepted.
** @return status, EC_Normal if successful, an error code otherwise
*/
OFCondition setSOPInstanceUID(DcmItem &dataset,
const DcmTagKey &tagKey,
const unsigned long pos = 0,
const OFBool check = OFTrue);
protected:
/** get pointer to reference value
** @return pointer to reference value (never NULL)
*/
inline DSRCompositeReferenceValue *getValuePtr()
{
return this;
}
/** read reference value from dataset
** @param dataset DICOM dataset from which the value 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 readItem(DcmItem &dataset,
const size_t flags);
/** write reference value to dataset
** @param dataset DICOM dataset to which the value should be written
** @return status, EC_Normal if successful, an error code otherwise
*/
virtual OFCondition writeItem(DcmItem &dataset) const;
/** check the specified SOP class UID for validity.
* The only checks performed are that the UID is non-empty and that it conforms to the
* corresponding VR (UI) and VM (1). Derived classes should overwrite this method for
* more specific tests (e.g. allowing only particular SOP classes).
** @param sopClassUID SOP class UID to be checked
** @return status, EC_Normal if value is valid, an error code otherwise
*/
virtual OFCondition checkSOPClassUID(const OFString &sopClassUID) const;
/** check the specified SOP instance UID for validity.
* The only checks performed are that the UID is non-empty and that it conforms to the
* corresponding VR (UI) and VM (1). Derived classes should overwrite this method for
* more specific tests.
* @param sopInstanceUID SOP instance UID to be checked
** @return status, EC_Normal if value is valid, an error code otherwise
*/
virtual OFCondition checkSOPInstanceUID(const OFString &sopInstanceUID) const;
/** check the currently stored reference value for validity.
* See above checkXXX() methods for details.
** @return status, EC_Normal if current value is valid, an error code otherwise
*/
OFCondition checkCurrentValue() const;
/// reference SOP class UID (VR=UI, type 1)
OFString SOPClassUID;
/// reference SOP instance UID (VR=UI, type 1)
OFString SOPInstanceUID;
};
#endif
|