Fix mistypings

[gdcm.git] / src / gdcmCommon.h

diff --git a/src/gdcmCommon.h b/src/gdcmCommon.h
index 27c4e90a3c5aba8f991457b49fdc185ae67cfe6f..98ff3901ec7b0c9181118d82356890b51d64c485 100644 (file)
--- a/src/gdcmCommon.h
+++ b/src/gdcmCommon.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmCommon.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/18 09:17:08 $
-  Version:   $Revision: 1.94 $
+  Date:      $Date: 2007/08/22 16:14:03 $
+  Version:   $Revision: 1.116 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -16,22 +16,50 @@
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMCOMMON_H
-#define GDCMCOMMON_H
+#ifndef _GDCMCOMMON_H_
+#define _GDCMCOMMON_H_
 
 #include "gdcmConfigure.h"
 #include "gdcmSystem.h"
+#include "gdcmMacro.h"
+#include "gdcmVRKey.h"
+#include <string>
+
+//-----------------------------------------------------------------------------
+#if defined(_WIN32) && defined(BUILD_SHARED_LIBS)
+  #ifdef gdcm_EXPORTS
+    #define GDCM_EXPORT __declspec( dllexport )
+  #else
+    #define GDCM_EXPORT __declspec( dllimport )
+  #endif
+#else
+  #define GDCM_EXPORT
+#endif
+
+#ifdef __BORLANDC__
+#include <mem.h>
+#endif
 
 //-----------------------------------------------------------------------------
 /// \brief namespace for Grass root DiCoM
-namespace gdcm
+namespace GDCM_NAME_SPACE
 {
 
 // Centralize information about the gdcm dictionary in only one file:
+//
+// ==>
+// ==> Don't forget gdcm/gdcmPython/gdcm.i
+// ==>
+//
+
 #ifndef PUB_DICT_PATH
 #  define PUB_DICT_PATH   "../Dicts/"
 #endif
-#define PUB_DICT_NAME     "DicomV3Dict"
+#define PUB_DICT_NAME     "dicomV3Dict"
+
+// dicomV3.dic replaced by the generated gdcm.dic/
+// if gdcm.dic not found, method FillDefaultDataDict() is invoked
+//#define PUB_DICT_FILENAME "dicomV3.dic"
 #define PUB_DICT_FILENAME "gdcm.dic"
 #define DICT_ELEM         "DicomDir.dic"
 #define DICT_TS           "dicomTS.dic"
@@ -45,6 +73,11 @@ 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 char GDCM_VRUNKNOWN[2];
+
+GDCM_EXPORT extern const char GDCM_FILESEPARATOR;
+
 /// \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
@@ -53,37 +86,6 @@ GDCM_EXPORT extern const std::string GDCM_PIXELDATA;
 /// We'll fix the mess up -without any change in the API- as soon as the bench
 /// marks are fully performed.
 
-#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
-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)
@@ -98,11 +100,16 @@ typedef std::string TagName;
 
 /// \brief various types of a DICOM file (for internal use only)
 enum FileType {
+// note to developer : don't forget to add as well in vtkGdcmWriter.h !
    Unknown = 0,
    ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
    ImplicitVR,
    ACR,
-   ACR_LIBIDO
+   ACR_LIBIDO,
+   /// \todo FIXME : an encapsulated JPEG file may be 
+   ///              either ExplicitVR or ImplicitVR, right?
+   JPEG,
+   JPEG2000
 };
 
 /// \brief type of the elements composing a DICOMDIR (for internal use only)
@@ -137,15 +144,36 @@ enum LodModeType
                                 // (*exclusive* from LD_NOSEQ and LD_NOSHADOW)
 };
 
+/// \brief Only user knows what kind of image he is going to write  !
+///
+/// -1) user created ex nihilo his own image and wants to write it as a Dicom image.
+///    USER_OWN_IMAGE
+/// -2) user modified the pixels of an existing image.
+///    FILTERED_IMAGE
+/// -3) user created a new image, using existing images (eg MIP, MPR, cartography image)
+///   CREATED_IMAGE
+/// -4) user modified/added some tags *without processing* the pixels (anonymization...
+///   UNMODIFIED_PIXELS_IMAGE
+enum ImageContentType
+{
+// note to developer : don't forget to add as well in vtkGdcmWriter.h !
+      USER_OWN_IMAGE = 1,
+      FILTERED_IMAGE,
+      CREATED_IMAGE,      
+      UNMODIFIED_PIXELS_IMAGE            
+}; 
+  
 /**
  * \brief structure, for internal use only
  */  
-struct Element
+struct DicomElement
 {
-   /// DicomGroup number
+   /// Dicom Group number
    unsigned short int Group;
-   /// DicomElement number
+   /// Dicom Element number
    unsigned short int Elem;
+   /// Value Representation
+   VRKey VR;
    /// value (coded as a std::string) of the Element
    std::string Value;
 };