* gdcmPython/testSuite.py : test the readable flag of file for tests

[gdcm.git] / src / gdcmHeader.h

diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h
index 9d704b5ae8d87cea8c974fbd869f5f87b9fffc5f..2bfd53cb3cbc8fc9f3a9fa3955b766d62452b7e3 100644 (file)
--- a/src/gdcmHeader.h
+++ b/src/gdcmHeader.h
@@ -1,4 +1,4 @@
-// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.44 2003/11/13 10:23:40 malaterre Exp $
+// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.46 2004/01/12 13:12:28 regrain Exp $
 
 #ifndef GDCMHEADER_H
 #define GDCMHEADER_H
@@ -16,25 +16,25 @@ typedef std::string VRKey;
 typedef std::string VRAtr;
 typedef std::map<VRKey, VRAtr> VRHT;    // Value Representation Hash Table
 
-/// The purpose of an instance of gdcmHeader is to act as a container of
-/// all the DICOM elements and their corresponding values (and
-/// additionaly the corresponding DICOM dictionary entry) of the header
-/// of a DICOM file.
-///
-/// The typical usage of instances of class gdcmHeader is to classify a set of
-/// dicom files according to header information e.g. to create a file hierarchy
-/// reflecting the Patient/Study/Serie informations, or extracting a given
-/// SerieId. Accesing the content (image[s] or volume[s]) is beyond the
-/// functionality of this class and belongs to gdmcFile.
-/// \note  The various entries of the explicit value representation (VR) shall
-///        be managed within a dictionary which is shared by all gdcmHeader
-///        instances.
-/// \note  The gdcmHeader::Set*Tag* family members cannot be defined as
-///        protected due to Swig limitations for as Has_a dependency between
-///        gdcmFile and gdcmHeader.
-
+/*
+ * The purpose of an instance of gdcmHeader is to act as a container of
+ * all the DICOM elements and their corresponding values (and
+ * additionaly the corresponding DICOM dictionary entry) of the header
+ * of a DICOM file.
+ *
+ * The typical usage of instances of class gdcmHeader is to classify a set of
+ * dicom files according to header information e.g. to create a file hierarchy
+ * reflecting the Patient/Study/Serie informations, or extracting a given
+ * SerieId. Accesing the content (image[s] or volume[s]) is beyond the
+ * functionality of this class and belongs to gdmcFile.
+ * \note  The various entries of the explicit value representation (VR) shall
+ *        be managed within a dictionary which is shared by all gdcmHeader
+ *        instances.
+ * \note  The gdcmHeader::Set*Tag* family members cannot be defined as
+ *        protected due to Swig limitations for as Has_a dependency between
+ *        gdcmFile and gdcmHeader.
+ */
 class GDCM_EXPORT gdcmHeader {
-   void SkipBytes(guint32);
 private:
    /// Pointer to the Value Representation Hash Table which contains all
    /// the VR of the DICOM version3 public dictionary. 
@@ -58,7 +58,7 @@ private:
    std::string filename; 
   
    int enableSequences;
-     
+
    // FIXME sw should be an enum e.g.
    //enum EndianType {
       //LittleEndian, 
@@ -82,42 +82,44 @@ private:
    void CheckSwap(void);
    void SwitchSwapToBigEndian(void);
    // CLEAN ME: NewManualElValToPubDict is NOT called any more.
-   gdcmElValue*  NewManualElValToPubDict(std::string NewTagName,
+   gdcmElValue *NewManualElValToPubDict(std::string NewTagName,
                                          std::string VR);
    void SetMaxSizeLoadElementValue(long);
 
-   gdcmDictEntry * GetDictEntryByNumber(guint16, guint16);
-   gdcmDictEntry * GetDictEntryByName  (std::string Name);
+   gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
+   gdcmDictEntry *GetDictEntryByName  (std::string Name);
 
    // ElValue related utilities
-   gdcmElValue * ReadNextElement(void);
-   gdcmElValue * NewElValueByNumber(guint16 group, guint16 element);
-   gdcmElValue * NewElValueByName  (std::string Name);
+   gdcmElValue *ReadNextElement(void);
+   gdcmElValue *NewElValueByNumber(guint16 group, guint16 element);
+   gdcmElValue *NewElValueByName  (std::string Name);
 
    void FindLength          (gdcmElValue *);
    void FindVR              (gdcmElValue *);
    void LoadElementValue    (gdcmElValue *);
    void LoadElementValueSafe(gdcmElValue *);
    void SkipElementValue    (gdcmElValue *);
-   void FixFoundLength      (gdcmElValue*, guint32);
+   void FixFoundLength      (gdcmElValue *, guint32);
    bool IsAnInteger         (gdcmElValue *);
    void LoadElements(void);
-   
+   void SkipBytes(guint32);
+
 protected:
-   FILE * fp;
    FileType filetype;
-   
+   FILE * fp;
+
    gdcmElValue * GetElValueByNumber(guint16 group, guint16 element);
    int CheckIfExistByNumber(guint16 Group, guint16 Elem );
 
-   guint16 SwapShort(guint16); // needed by gdcmFile
-   guint32 SwapLong(guint32);  // for JPEG Files :-(
-   bool OpenFile(bool exception_on_error = false)
-     throw(gdcmFileError);
-   bool CloseFile(void);
    int write(std::ostream&);   
    int anonymize(std::ostream&);  // FIXME : anonymize should be a friend ?
+
 public:
+   FILE *OpenFile(bool exception_on_error = false)
+     throw(gdcmFileError);
+   bool CloseFile(void);
+   FileType GetFileType(void);
+
    bool IsReadable(void);
    bool IsImplicitVRLittleEndianTransferSyntax(void);
    bool IsExplicitVRLittleEndianTransferSyntax(void);
@@ -135,10 +137,10 @@ public:
    virtual void ParseHeader(bool exception_on_error = false)
      throw(gdcmFormatError);
      
-   gdcmHeader( bool exception_on_error = false);
+   gdcmHeader(bool exception_on_error = false);
    gdcmHeader(const char *filename, 
               bool  exception_on_error = false, 
-             bool  enable_sequences   = false);
+              bool  enable_sequences   = false);
              
    virtual ~gdcmHeader();
 
@@ -213,7 +215,11 @@ public:
    int    GetLUTNbits(void);
    unsigned char * GetLUTRGBA(void);
            
+   void SetImageDataSize (size_t ExpectedSize);
 
+// System access
+   guint16 SwapShort(guint16); // needed by gdcmFile
+   guint32 SwapLong(guint32);  // for JPEG Files
 };
 
 #endif