]> Creatis software - gdcm.git/blob - src/gdcmCommon.h
* src/gdcmDictGroupName.[h|cxx] : add a correlation between a group (number)
[gdcm.git] / src / gdcmCommon.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmCommon.h,v $
5   Language:  C++
6   Date:      $Date: 2005/04/05 10:56:25 $
7   Version:   $Revision: 1.63 $
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 #define DICT_GROUP_NAME   "DictGroupName.dic"
96
97 GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
98 GDCM_EXPORT extern const std::string GDCM_UNFOUND;
99 GDCM_EXPORT extern const std::string GDCM_BINLOADED;
100 GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
101 GDCM_EXPORT extern const std::string GDCM_UNREAD;
102
103 /// \brief TagKey is made to hold an "universal" (as in URL, Universal
104 ///        Ressource Locator) key to a DocEntry i.e. a dicom tag.
105 ///        A dicom tag always has a group and an elem, but a set of tags
106 ///        embeded in various (optionally nested) sequences and sharing
107 ///        the same group and elem all share the same (group, elem)
108 ///        "identifier". Hence the (group, elem) cannot be used as an
109 ///        identifier (in gdcm we shall refer to a "TagKey") of a tag.
110 ///        In order to construct a proper tag identifier (i.e. a key) we
111 ///        consider the following definition of a TagKey:
112 ///        - let Group, Element be the string representation of the
113 ///          group and elem dicom tag members,
114 ///        - let ItemNumber be the string representation of the integer
115 ///          index of the considered item number of a sequence,
116 ///        Let the key of a tag embeded in a sequence, noted SeqTag, be
117 ///        the form:
118 ///           /ItemNumber#Group|Element
119 ///        where "/", "#" and "|" are characters acting as separators.
120 ///        Then the general form of a TagKey is given by:
121 ///           Group|Element[SeqTag]
122 ///        where [SeqTag] means NO or many instances of SeqTag.
123 ///        Hence the TagKey of a tag not "leaving" in a sequence is the
124 ///        string e.g. 
125 ///            0028|1201
126 ///        but the TagKey of a tag "embeded" is the first item of
127 ///        a sequence, itself nested in the third item of a sequence is the
128 ///        string e.g.
129 ///            0004|1220/2#0008|0082/0#0008|0090
130 typedef std::string TagKey;
131 typedef std::string TagName;
132
133 enum FileType {
134    Unknown = 0,
135    ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
136    ImplicitVR,
137    ACR,
138    ACR_LIBIDO
139 };
140
141 /// \brief type of the elements composing a DICOMDIR (for internal use only)
142 enum DicomDirType {
143    DD_UNKNOWN = 0,
144    DD_META,
145    DD_PATIENT,
146    DD_STUDY,
147    DD_SERIE,
148    DD_IMAGE
149 };
150
151 /**
152  * \brief structure, for internal use only
153  */  
154 GDCM_EXPORT typedef struct
155 {
156    /// DicomGroup number
157    unsigned short int Group;
158    /// DicomElement number
159    unsigned short int Elem;
160    /// value (coded as a std::string) of the Element
161    std::string Value;
162 } Element;
163
164 } //namespace gdcm
165 //-----------------------------------------------------------------------------
166 #endif