]> Creatis software - gdcm.git/blobdiff - src/gdcmCommon.h
* Fix some bugs
[gdcm.git] / src / gdcmCommon.h
index ba376a4228e5d2468a886f483008c1b6c71fa402..5d90974289890f27f39f719923ba35694920d48d 100644 (file)
-//gdcmCommon.h
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmCommon.h,v $
+  Language:  C++
+  Date:      $Date: 2005/10/19 08:06:45 $
+  Version:   $Revision: 1.97 $
+                                                                                
+  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
 
-#ifdef __GNUC__
-#include <stdint.h>
-#define guint16 uint16_t
-#define guint32 uint32_t
+#include "gdcmConfigure.h"
+#include "gdcmSystem.h"
+
+#include <string>
+
+#define FASTTAGKEY 0
+
+// FIXME: Should rewrite this:
+#if FASTTAGKEY
+   #include <iostream>
+   #include <iomanip>
+#endif
+   #if defined(_MSC_VER) && (_MSC_VER == 1200)
+   /* ostream operator for std::string since VS6 does not provide it*/
+      #include <iostream>
 #endif
 
-#ifdef _MSC_VER 
-typedef  unsigned short guint16;
-typedef  unsigned int   guint32;
+//-----------------------------------------------------------------------------
+/// \brief namespace for Grass root DiCoM
+namespace gdcm
+{
+
+// Centralize information about the gdcm dictionary in only one file:
+#ifndef PUB_DICT_PATH
+#  define PUB_DICT_PATH   "../Dicts/"
 #endif
+#define PUB_DICT_NAME     "DicomV3Dict"
+#define PUB_DICT_FILENAME "gdcm.dic"
+#define DICT_ELEM         "DicomDir.dic"
+#define DICT_TS           "dicomTS.dic"
+#define DICT_VR           "dicomVR.dic"
+#define DICT_GROUP_NAME   "DictGroupName.dic"
+
+GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
+GDCM_EXPORT extern const std::string GDCM_UNFOUND;
+GDCM_EXPORT extern const std::string GDCM_BINLOADED;
+GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
+GDCM_EXPORT extern const std::string GDCM_UNREAD;
+GDCM_EXPORT extern const std::string GDCM_NOTASCII;
+GDCM_EXPORT extern const std::string GDCM_PIXELDATA;
+
+GDCM_EXPORT extern const std::string GDCM_VRUNKNOWN;
+
+/// \brief TagKey is made to hold the standard Dicom Tag 
+///               (Group number, Element number)
+/// Instead of using the two '16 bits integers' as the Hask Table key, we
+/// converted into a string (e.g. 0x0018,0x0050 converted into "0018|0050")
+/// It appears to be a huge waste of time.
+/// We'll fix the mess up -without any change in the API- as soon as the bench
+/// marks are fully performed.
 
-#ifdef _MSC_VER
-#define GDCM_EXPORT __declspec( dllexport )
+#if FASTTAGKEY
+typedef union   {
+      uint16_t  tab[2];
+      uint32_t  tagkey;
+    } TagKey;
+/* ostream operator for TagKey */
+inline std::ostream& operator<<(std::ostream& _O, TagKey _val)
+{
+   _O.setf( std::ios::right);
+   return (_O << std::hex << std::setw( 4 ) << std::setfill( '0' )
+      << _val.tab[0] << '|' << std::setw( 4 ) << std::setfill( '0' )
+      << _val.tab[1] << std::setfill( ' ' ) << std::dec);
+}
+inline bool operator==(TagKey _self, TagKey _val)
+{
+   return _self.tagkey == _val.tagkey;
+}
+inline bool operator<(TagKey _self, TagKey _val)
+{
+   // This expression is a tad faster but PrintFile output
+   // is more difficult to read
+   //return _self.tagkey < _val.tagkey;
+
+   // More usal order of dicom tags:
+   if( _self.tab[0] == _val.tab[0] )
+      return _self.tab[1] < _val.tab[1];
+   return _self.tab[0] < _val.tab[0];
+}
 #else
-#define GDCM_EXPORT
+typedef std::string TagKey;
+#endif
+#if defined(_MSC_VER) && (_MSC_VER == 1200)
+// Doing everything within gdcm namespace to avoid polluting 3d party software
+inline std::ostream& operator<<(std::ostream& _O, std::string _val)
+{
+  return _O << _val.c_str();
+}
 #endif
 
-#include <string>
-typedef string TagKey;
-typedef string TagName;
+/// \brief TagName is made to hold the 'non hexa" fields (VR, VM, Name) 
+///        of Dicom Entries
+typedef std::string TagName;
+
+/// \brief various types of a DICOM file (for internal use only)
+enum FileType {
+   Unknown = 0,
+   ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
+   ImplicitVR,
+   ACR,
+   ACR_LIBIDO,
+   JPEG
+};
+
+/// \brief type of the elements composing a DICOMDIR (for internal use only)
+enum DicomDirType {
+   DD_UNKNOWN = 0,
+   DD_META,
+   DD_PATIENT,
+   DD_STUDY,
+   DD_SERIE,
+   DD_IMAGE,
+   DD_VISIT
+};
+
+/// \brief comparison operators (as used in SerieHelper::AddRestriction() )
+enum CompOperators {
+   GDCM_EQUAL = 0,
+   GDCM_DIFFERENT,
+   GDCM_GREATER,
+   GDCM_GREATEROREQUAL,
+   GDCM_LESS,
+   GDCM_LESSOREQUAL
+};
+
+/// \brief Loading mode
+enum LodModeType
+{
+   LD_ALL         = 0x00000000, // Load all
+   LD_NOSEQ       = 0x00000001, // Don't load Sequences
+   LD_NOSHADOW    = 0x00000002, // Don't load odd groups
+   LD_NOSHADOWSEQ = 0x00000004  // Don't load Sequences if they belong 
+                                //            to an odd group
+                                // (*exclusive* from LD_NOSEQ and LD_NOSHADOW)
+};
+
+/**
+ * \brief structure, for internal use only
+ */  
+struct Element
+{
+   /// DicomGroup number
+   unsigned short int Group;
+   /// DicomElement number
+   unsigned short int Elem;
+   /// value (coded as a std::string) of the Element
+   std::string Value;
+};
 
+} //namespace gdcm
+//-----------------------------------------------------------------------------
 #endif