src/gdcmCommon.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmCommon.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/20 17:15:53 $
   7   Version:   $Revision: 1.52 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMCOMMON_H
  20 #define GDCMCOMMON_H
  21
  22 #include "gdcmConfigure.h"
  23
  24 //-----------------------------------------------------------------------------
  25 //This is needed when compiling in debug mode
  26 #ifdef _MSC_VER
  27 // 'identifier' : class 'type' needs to have dll-interface to be used by
  28 // clients of class 'type2'
  29 #pragma warning ( disable : 4251 )
  30 // 'identifier' : identifier was truncated to 'number' characters in the
  31 // debug information
  32 #pragma warning ( disable : 4786 )
  33 //'identifier' : decorated name length exceeded, name was truncated
  34 #pragma warning ( disable : 4503 )
  35 // C++ exception specification ignored except to indicate a
  36 // function is not __declspec(nothrow)
  37 #pragma warning ( disable : 4290 )
  38 // signed/unsigned mismatch
  39 #pragma warning ( disable : 4018 )
  40 // return type for 'identifier' is '' (ie; not a UDT or reference to UDT. Will
  41 // produce errors if applied using infix notation
  42 #pragma warning ( disable : 4284 )
  43 // 'type' : forcing value to bool 'true' or 'false' (performance warning)
  44 // //#pragma warning ( disable : 4800 )
  45 #endif //_MSC_VER
  46
  47 //-----------------------------------------------------------------------------
  48 #ifdef CMAKE_HAVE_STDINT_H
  49 #include <stdint.h>   // For uint8_t uint16_t and uint32_t
  50 #else
  51 #if defined(_MSC_VER) || defined(__BORLANDC__)
  52 typedef  signed char    int8_t;
  53 #endif
  54 typedef  unsigned char  uint8_t;
  55 typedef  unsigned short uint16_t;
  56 typedef  unsigned int   uint32_t;
  57 #define UINT32_MAX    (4294967295U)
  58 #endif
  59
  60 #if defined(_WIN32) && defined(BUILD_SHARED_LIBS)
  61   #ifdef gdcm_EXPORTS
  62     #define GDCM_EXPORT __declspec( dllexport )
  63   #else
  64     #define GDCM_EXPORT __declspec( dllimport )
  65   #endif
  66 #else
  67   #define GDCM_EXPORT
  68 #endif
  69
  70 #include <string>
  71
  72 namespace gdcm
  73 {
  74
  75 // Centralize information about the gdcm dictionary in only one file:
  76 #ifndef PUB_DICT_PATH
  77 #  define PUB_DICT_PATH   "../Dicts/"
  78 #endif
  79 #define PUB_DICT_NAME     "DicomV3Dict"
  80 #define PUB_DICT_FILENAME "dicomV3.dic"
  81 #define DICT_ELEM         "DicomDir.dic"
  82 #define DICT_TS           "dicomTS.dic"
  83 #define DICT_VR           "dicomVR.dic"
  84
  85 GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
  86 GDCM_EXPORT extern const std::string GDCM_UNFOUND;
  87 GDCM_EXPORT extern const std::string GDCM_BINLOADED;
  88 GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
  89 GDCM_EXPORT extern const std::string GDCM_UNREAD;
  90
  91 /// \brief TagKey is made to hold an "universal" (as in URL, Universal
  92 ///        Ressource Locator)  key to a DocEntry i.e. a dicom tag.
  93 ///        A dicom tag always has a group and an elem, but a set of tags
  94 ///        embeded in various (optionally nested) sequences and sharing
  95 ///        the same group and elem all share the same (group, elem)
  96 ///        "identifier". Hence the (group, elem) cannot be used as an
  97 ///        identifier (in gdcm we shall refer to a "TagKey") of a tag.
  98 ///        In order to construct a proper tag identifier (i.e. a key) we
  99 ///        consider the following definition of a TagKey:
 100 ///        - let Group, Element be the string representation of the
 101 ///          group and elem dicom tag members,
 102 ///        - let ItemNumber be the string representation of the integer
 103 ///          index of the considered item number of a sequence,
 104 ///        Let the key of a tag embeded in a sequence, noted SeqTag, be
 105 ///        the form:
 106 ///           /ItemNumber#Group|Element
 107 ///        where "/", "#" and "|" are characters acting as separators.
 108 ///        Then the general form of a TagKey is given by:
 109 ///           Group|Element[SeqTag]
 110 ///        where [SeqTag] means NO or many instances of SeqTag.
 111 ///        Hence the TagKey of a tag not "leaving" in a sequence is the
 112 ///        string e.g.
 113 ///            0028|1201
 114 ///        but the TagKey of a tag "embeded" is the first item of
 115 ///        a sequence, itself nested in the third item of a sequence is the
 116 ///        string e.g.
 117 ///            0004|1220/2#0008|0082/0#0008|0090
 118 typedef std::string TagKey;
 119 typedef std::string TagName;
 120
 121 enum FileType {
 122    Unknown = 0,
 123    ExplicitVR, // DicomDir is in this case
 124    ImplicitVR,
 125    ACR,
 126    ACR_LIBIDO
 127 };
 128
 129 enum DicomDirType {
 130    DD_UNKNOWN = 0,
 131    DD_META,
 132    DD_PATIENT,
 133    DD_STUDY,
 134    DD_SERIE,
 135    DD_IMAGE
 136 };
 137 } //namespace gdcm
 138 //-----------------------------------------------------------------------------
 139 #endif