src/gdcmCommon.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmCommon.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/11 15:22:18 $
   7   Version:   $Revision: 1.62 $
   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 // non dll-interface class 'type' used as base for dll-interface class 'type2'
  31 #pragma warning ( disable : 4275 )
  32 // 'identifier' : identifier was truncated to 'number' characters in the
  33 // debug information
  34 #pragma warning ( disable : 4786 )
  35 //'identifier' : decorated name length exceeded, name was truncated
  36 #pragma warning ( disable : 4503 )
  37 // C++ exception specification ignored except to indicate a
  38 // function is not __declspec(nothrow)
  39 #pragma warning ( disable : 4290 )
  40 // signed/unsigned mismatch
  41 #pragma warning ( disable : 4018 )
  42 // return type for 'identifier' is '' (ie; not a UDT or reference to UDT. Will
  43 // produce errors if applied using infix notation
  44 #pragma warning ( disable : 4284 )
  45 // 'type' : forcing value to bool 'true' or 'false' (performance warning)
  46 // //#pragma warning ( disable : 4800 )
  47 #endif //_MSC_VER
  48
  49 //-----------------------------------------------------------------------------
  50 #ifdef CMAKE_HAVE_STDINT_H
  51    #include <stdint.h>
  52 #else
  53 #ifdef CMAKE_HAVE_INTTYPES_H
  54    // Old system only have this
  55    #include <inttypes.h>   // For uint8_t uint16_t and uint32_t
  56 #endif
  57 #endif
  58
  59 // Broken plateform do not respect C99 and do not provide those typedef
  60 #if defined(_MSC_VER) || defined(__BORLANDC__)
  61 typedef  signed char         int8_t;
  62 typedef  signed short        int16_t;
  63 typedef  signed int          int32_t;
  64 typedef  unsigned char       uint8_t;
  65 typedef  unsigned short      uint16_t;
  66 typedef  unsigned int        uint32_t;
  67 #define UINT32_MAX    (4294967295U)
  68 #endif
  69
  70 #if defined(_WIN32) && defined(BUILD_SHARED_LIBS)
  71   #ifdef gdcm_EXPORTS
  72     #define GDCM_EXPORT __declspec( dllexport )
  73   #else
  74     #define GDCM_EXPORT __declspec( dllimport )
  75   #endif
  76 #else
  77   #define GDCM_EXPORT
  78 #endif
  79
  80 #include <string>
  81
  82 /// \brief namespace for Grass root DiCoM
  83 namespace gdcm
  84 {
  85
  86 // Centralize information about the gdcm dictionary in only one file:
  87 #ifndef PUB_DICT_PATH
  88 #  define PUB_DICT_PATH   "../Dicts/"
  89 #endif
  90 #define PUB_DICT_NAME     "DicomV3Dict"
  91 #define PUB_DICT_FILENAME "dicomV3.dic"
  92 #define DICT_ELEM         "DicomDir.dic"
  93 #define DICT_TS           "dicomTS.dic"
  94 #define DICT_VR           "dicomVR.dic"
  95
  96 GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
  97 GDCM_EXPORT extern const std::string GDCM_UNFOUND;
  98 GDCM_EXPORT extern const std::string GDCM_BINLOADED;
  99 GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
 100 GDCM_EXPORT extern const std::string GDCM_UNREAD;
 101
 102 /// \brief TagKey is made to hold an "universal" (as in URL, Universal
 103 ///        Ressource Locator) key to a DocEntry i.e. a dicom tag.
 104 ///        A dicom tag always has a group and an elem, but a set of tags
 105 ///        embeded in various (optionally nested) sequences and sharing
 106 ///        the same group and elem all share the same (group, elem)
 107 ///        "identifier". Hence the (group, elem) cannot be used as an
 108 ///        identifier (in gdcm we shall refer to a "TagKey") of a tag.
 109 ///        In order to construct a proper tag identifier (i.e. a key) we
 110 ///        consider the following definition of a TagKey:
 111 ///        - let Group, Element be the string representation of the
 112 ///          group and elem dicom tag members,
 113 ///        - let ItemNumber be the string representation of the integer
 114 ///          index of the considered item number of a sequence,
 115 ///        Let the key of a tag embeded in a sequence, noted SeqTag, be
 116 ///        the form:
 117 ///           /ItemNumber#Group|Element
 118 ///        where "/", "#" and "|" are characters acting as separators.
 119 ///        Then the general form of a TagKey is given by:
 120 ///           Group|Element[SeqTag]
 121 ///        where [SeqTag] means NO or many instances of SeqTag.
 122 ///        Hence the TagKey of a tag not "leaving" in a sequence is the
 123 ///        string e.g.
 124 ///            0028|1201
 125 ///        but the TagKey of a tag "embeded" is the first item of
 126 ///        a sequence, itself nested in the third item of a sequence is the
 127 ///        string e.g.
 128 ///            0004|1220/2#0008|0082/0#0008|0090
 129 typedef std::string TagKey;
 130 typedef std::string TagName;
 131
 132 enum FileType {
 133    Unknown = 0,
 134    ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
 135    ImplicitVR,
 136    ACR,
 137    ACR_LIBIDO
 138 };
 139
 140 /// \brief type of the elements composing a DICOMDIR (for internal use only)
 141 enum DicomDirType {
 142    DD_UNKNOWN = 0,
 143    DD_META,
 144    DD_PATIENT,
 145    DD_STUDY,
 146    DD_SERIE,
 147    DD_IMAGE
 148 };
 149
 150 /**
 151  * \brief structure, for internal use only
 152  */
 153 GDCM_EXPORT typedef struct
 154 {
 155    /// DicomGroup number
 156    unsigned short int Group;
 157    /// DicomElement number
 158    unsigned short int Elem;
 159    /// value (coded as a std::string) of the Element
 160    std::string Value;
 161 } Element;
 162
 163 } //namespace gdcm
 164 //-----------------------------------------------------------------------------
 165 #endif