]> Creatis software - gdcm.git/blobdiff - src/gdcmCommon.h
Coding Style + Doxygenation
[gdcm.git] / src / gdcmCommon.h
index 46c3bc299485b32d956af6106e48f7f4da6ab8e0..2fb153918b4300c1ef995951ee0a0f423caa0cf4 100644 (file)
@@ -1,5 +1,21 @@
-//gdcmCommon.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmCommon.h,v $
+  Language:  C++
+  Date:      $Date: 2005/01/06 20:03:26 $
+  Version:   $Revision: 1.44 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMCOMMON_H
 #define GDCMCOMMON_H
 
 #endif //_MSC_VER
 
 //-----------------------------------------------------------------------------
-#ifdef __GNUC__
-#ifndef HAVE_NO_STDINT_H
-#include <stdint.h>
-#define guint16 uint16_t
-#define guint32 uint32_t
-#define gint16  int16_t
-#define gint32  int32_t
-#else
-typedef  unsigned short guint16;
-typedef  unsigned int   guint32;
-typedef  short          gint16;
-typedef  int                   gint32;
-#define UINT32_MAX    (4294967295U)
-#endif //HAVE_NO_STDINT_H
+// ifdef for old gcc compiler
+#ifdef GDCM_NO_ANSI_STRING_STREAM
+#  include <strstream>
+#  define  ostringstream ostrstream
+# else
+#  include <sstream>
 #endif
 
-#ifdef _MSC_VER 
-typedef  unsigned short guint16;
-typedef  unsigned int   guint32;
-typedef  short                 gint16;
-typedef  int            gint32;
+#include <string>
+#include <assert.h>
+
+#ifdef GDCM_HAVE_STDINT_H
+#include <stdint.h>   // For uint8_t uint16_t and uint32_t
+#else
+#if defined(_MSC_VER) || defined(__BORLANDC__)
+typedef  signed char    int8_t;
+#endif
+typedef  unsigned char  uint8_t;
+typedef  unsigned short uint16_t;
+typedef  unsigned int   uint32_t;
 #define UINT32_MAX    (4294967295U)
 #endif
 
-#ifdef _MSC_VER
+#if defined(_MSC_VER) || defined(__BORLANDC__)
 #define GDCM_EXPORT __declspec( dllexport )
-#define getcwd _getcwd
 #else
 #define GDCM_EXPORT
 #endif
 
-// ifdef for old gcc / broken compiler
-#ifdef GDCM_NO_ANSI_STRING_STREAM
-#  include <strstream>
-#  define  ostringstream ostrstream
-# else
-#  include <sstream>
-#endif
-
+namespace gdcm
+{
 
 // Centralize information about the gdcm dictionary in only one file:
 #ifndef PUB_DICT_PATH
@@ -79,20 +87,49 @@ typedef  int            gint32;
 #define DICT_TS           "dicomTS.dic"
 #define DICT_VR           "dicomVR.dic"
 
-#include <string>
-
-const std::string GDCM_UNFOUND = "gdcm::Unfound";   /// MEMORY LEAK
+const std::string GDCM_UNKNOWN   = "gdcm::Unknown";
+const std::string GDCM_UNFOUND   = "gdcm::Unfound";
+const std::string GDCM_BINLOADED = "gdcm::Binary data loaded";
+const std::string GDCM_NOTLOADED = "gdcm::NotLoaded";
+const std::string GDCM_UNREAD    = "gdcm::UnRead";
 
+/// \brief TagKey is made to hold an "universal" (as in URL, Universal
+///        Ressource Locator)  key to a DocEntry i.e. a dicom tag.
+///        A dicom tag always has a group and an element, but a set of tags
+///        embeded in various (optionally nested) sequences and sharing
+///        the same group and element all share the same (group, element)
+///        "identifier". Hence the (group, element) cannot be used as an
+///        identifier (in gdcm we shall refer to a "TagKey") of a tag.
+///        In order to construct a proper tag identifier (i.e. a key) we
+///        consider the following definition of a TagKey:
+///        - let Group, Element be the string representation of the
+///          group and element dicom tag members,
+///        - let ItemNumber be the string representation of the integer
+///          index of the considered item number of a sequence,
+///        Let the key of a tag embeded in a sequence, noted SeqTag, be
+///        the form:
+///           /ItemNumber#Group|Element
+///        where "/", "#" and "|" are characters acting as separators.
+///        Then the general form of a TagKey is given by:
+///           Group|Element[SeqTag]
+///        where [SeqTag] means NO or many instances of SeqTag.
+///        Hence the TagKey of a tag not "leaving" in a sequence is the
+///        string e.g. 
+///            0028|1201
+///        but the TagKey of a tag "embeded" is the first item of
+///        a sequence, itself nested in the third item of a sequence is the
+///        string e.g.
+///            0004|1220/2#0008|0082/0#0008|0090
 typedef std::string TagKey;
 typedef std::string TagName;
 
 enum FileType {
-      gdcmUnknown = 0,
-      gdcmExplicitVR, // gdcmDicomDir is in this case
-      gdcmImplicitVR,
-      gdcmACR,
-      gdcmACR_LIBIDO
+      Unknown = 0,
+      ExplicitVR, // DicomDir is in this case
+      ImplicitVR,
+      ACR,
+      ACR_LIBIDO
 };
-
+} //namespace gdcm
 //-----------------------------------------------------------------------------
 #endif