]> Creatis software - gdcm.git/commitdiff
Cosmetics
authorjpr <jpr>
Sun, 30 Jan 2005 17:30:57 +0000 (17:30 +0000)
committerjpr <jpr>
Sun, 30 Jan 2005 17:30:57 +0000 (17:30 +0000)
13 files changed:
src/gdcmBase.h
src/gdcmBinEntry.cxx
src/gdcmBinEntry.h
src/gdcmCommon.h
src/gdcmContentEntry.cxx
src/gdcmContentEntry.h
src/gdcmDebug.cxx
src/gdcmDocEntry.cxx
src/gdcmDocEntry.h
src/gdcmJPEGFragmentsInfo.h
src/gdcmRLEFramesInfo.h
src/gdcmSQItem.cxx
src/gdcmValEntry.cxx

index 9304052d264b78241cb6940be52c92bb934e4fce..0036ba22115edd06e1ef5c07ebabe298d6803f80 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBase.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/21 11:40:55 $
-  Version:   $Revision: 1.4 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.5 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,7 +27,6 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 /**
  * \brief Base class of all gdcm classes
- *
  * Contains the Print related methods :
  *  - Print 
  *  - SetPrintLevel / GetPrintLevel 
@@ -38,7 +37,8 @@ public:
    Base( );
    virtual ~Base();
 
-   virtual void Print(std::ostream &os = std::cout, std::string const & indent = "" ); 
+   virtual void Print(std::ostream &os = std::cout, 
+                      std::string const & indent = "" ); 
 
    /// \brief Sets the print level for the Dicom Header Elements
    /// \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy
index f572c83ea9a15abf148b9048d403caee987bff3d..037db638ea6d91394b33e68ab3f4284547e1993f 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBinEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:10:56 $
-  Version:   $Revision: 1.58 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.59 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -64,7 +64,6 @@ BinEntry::~BinEntry()
    }
 }
 
-
 //-----------------------------------------------------------------------------
 // Print
 /**
@@ -101,7 +100,7 @@ void BinEntry::Print(std::ostream &os, std::string const & )
 
 //-----------------------------------------------------------------------------
 // Public
-/*
+/**
  * \brief   canonical Writer
  * @param fp already open file pointer
  * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
index 63637ebe70e4317b8a9717b562c1923a4689c04c..f7fa6485bbd3f0b67391976892216be8ebaf894b 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmBinEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:10:56 $
-  Version:   $Revision: 1.34 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.35 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -44,6 +44,7 @@ public:
    ~BinEntry();
    
    void Print( std::ostream &os = std::cout, std::string const & indent = "" );
+
    void WriteContent( std::ofstream *fp, FileType ft);
 
    /// \brief Returns the area value of the current Dicom Entry
@@ -51,13 +52,16 @@ public:
    uint8_t *GetBinArea()  { return BinArea; }
 
    void  SetBinArea( uint8_t *area, bool self = true );
+   /// \brief Sets SelfArea
    void SetSelfArea(bool area) { SelfArea = area; };
+   /// \brief Returns SelfArea
    bool IsSelfArea() { return SelfArea; };
 
 private:
    /// \brief memory area to hold 'non std::string' representable values 
    ///       (ie : Lookup Tables, overlays, icons)   
    uint8_t *BinArea;
+   /// \brief Whether BinEntry has its own BinArea or not
    bool SelfArea;
 };
 
index 16af192899687c59d0958fa4be1fba33a5785d91..a51dd6603d2920aaa065f09e2b47f81bc0a2c88d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmCommon.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 00:02:15 $
-  Version:   $Revision: 1.58 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.59 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -97,7 +97,7 @@ GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
 GDCM_EXPORT extern const std::string 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.
+///        Ressource Locator) key to a DocEntry i.e. a dicom tag.
 ///        A dicom tag always has a group and an elem, but a set of tags
 ///        embeded in various (optionally nested) sequences and sharing
 ///        the same group and elem all share the same (group, elem)
@@ -123,12 +123,13 @@ GDCM_EXPORT extern const std::string GDCM_UNREAD;
 ///        a sequence, itself nested in the third item of a sequence is the
 ///        string e.g.
 ///            0004|1220/2#0008|0082/0#0008|0090
+///        Probabely useless stuff.
 typedef std::string TagKey;
 typedef std::string TagName;
 
 enum FileType {
    Unknown = 0,
-   ExplicitVR, // DicomDir is in this case
+   ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
    ImplicitVR,
    ACR,
    ACR_LIBIDO
@@ -142,6 +143,7 @@ enum DicomDirType {
    DD_SERIE,
    DD_IMAGE
 };
+
 } //namespace gdcm
 //-----------------------------------------------------------------------------
 #endif
index d48ac1c2e636abdd81dce78d57aeda0e16f7834a..22ca6d2f6a6b0442c0173320de5f436513699d5f 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmContentEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:10:56 $
-  Version:   $Revision: 1.7 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.8 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -56,6 +56,9 @@ ContentEntry::~ContentEntry ()
 {
 }
 
+//-----------------------------------------------------------------------------
+// Print
+
 //-----------------------------------------------------------------------------
 // Public
 void ContentEntry::Copy(DocEntry *doc)
index da8db0ed38092ec8cb651c91e015a0d5b6a4cabc..8cb66a0a56d0586995df25e2584762269e20b908 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmContentEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:10:56 $
-  Version:   $Revision: 1.3 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.4 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -40,6 +40,7 @@ public:
    virtual void WriteContent(std::ofstream *fp, FileType filetype) = 0;
 
    // Accessors are protected, not to be invoked by end user
+
    /// Sets the value (string) of the current Dicom entry
    virtual void SetValue(std::string const &val) { Value = val; };
  
index 41f6f18cbb5a5301ecdc126b7ba39eefe9ce2f6b..82ced4141d27c695ad8e4630adafaa88f2ddc7ca 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/27 11:55:57 $
-  Version:   $Revision: 1.18 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.19 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -28,6 +28,9 @@ static bool DebugToFile = false;
 static std::ofstream DebugFile;
 
 
+//-----------------------------------------------------------------------------
+// Constructor / Destructor
+
 Debug::Debug()
 {
 
@@ -38,7 +41,14 @@ Debug::~Debug()
   if ( DebugFile.is_open() )
       DebugFile.close();     
 }
+
 //-----------------------------------------------------------------------------
+// Print
+
+
+//-----------------------------------------------------------------------------
+// Public
+
 /**
  * \brief   Accessor
  * @param   flag Set the debug flag
@@ -76,7 +86,7 @@ bool Debug::GetDebugToFile ()
 }
 
 /**
- * \brief   Accessor
+ * \brief   Set Accessor
  * @param   flag Set the debug flag to redirect to file
  *          Absolutely nothing is check. You have to pass in
  *          a correct filename
@@ -90,11 +100,22 @@ void Debug::SetDebugFilename (std::string const &filename)
    DebugFile.open( filename.c_str() );
 }
 
+/**
+ * \brief   Get Accessor
+ * @return Debug file
+ */
 std::ofstream &Debug::GetDebugFile ()
 {
   return DebugFile;
 }
 
+//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+   
+//-----------------------------------------------------------------------------
 } // end namespace gdcm
 
 
index ec54641571e7440c813901897b79c9e49a1d7e4e..a1f5882ed1d3916c72db66824daac467dbab6fb9 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:10:56 $
-  Version:   $Revision: 1.48 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.49 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -134,12 +134,11 @@ void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
      // we just *always* ignore spurious fffe|0000 tag !   
       return;
    }
-
    //
    // ----------- Writes the common part
    //
-   binary_write( *fp, group);  //group
-   binary_write( *fp, el);  //element
+   binary_write( *fp, group); //group
+   binary_write( *fp, el);    //element
 
    if ( filetype == ExplicitVR )
    {
@@ -234,14 +233,14 @@ uint32_t DocEntry::GetFullLength()
 
 /**
  * \brief   Copies all the attributes from an other DocEntry 
- * @param e entry to copy from
+ * @param doc entry to copy from
  */
-void DocEntry::Copy(DocEntry *e)
+void DocEntry::Copy(DocEntry *doc)
 {
-   Length     = e->Length;
-   ReadLength = e->ReadLength;
-   ImplicitVR = e->ImplicitVR;
-   Offset     = e->Offset;
+   Length     = doc->Length;
+   ReadLength = doc->ReadLength;
+   ImplicitVR = doc->ImplicitVR;
+   Offset     = doc->Offset;
 }
 
 /**
@@ -252,6 +251,7 @@ bool DocEntry::IsItemDelimitor()
 {
    return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
 }
+
 /**
  * \brief   tells us if entry is the last one of a 'no length' Sequence 
  *          (fffe,e0dd) 
index ba8718c583053087efd9287921801a1b9f9fae03..02debe38edd508e84285d5f6d862dc6e6c77a343 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:10:56 $
-  Version:   $Revision: 1.42 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.43 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -128,7 +128,7 @@ public:
    
    uint32_t GetFullLength();
    
-   virtual void Copy(DocEntry *doc);
+   virtual void Copy(DocEntry *e);
 
    bool IsItemDelimitor();
    bool IsSequenceDelimitor();   
index 20f17977a2c640b539f7ad18031ea114f7b19ab5..da248099637d809279777affa9dd74cc4679eff7 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmJPEGFragmentsInfo.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:42:22 $
-  Version:   $Revision: 1.15 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.16 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,9 +31,8 @@ namespace gdcm
  * \brief Utility class for gathering the informations of the collection
  *        of JPEG fragment[s] (see \ref JPEGFragment)  when handling
  *        "Encapsulated JPEG Compressed Images". 
- *        The informations on each frame are obtained during the parsing
- *        of a Document (refer to
- *         \ref Document::ComputeJPEGFragmentInfo() ).
+ *        The informations on each frame are obtained during the pixel parsing
+ *        of a gdcm::File (refer to \ref File::ComputeJPEGFragmentInfo() ).
  *        They shall be used when (if necessary) decoding the fragments.
  *
  *        This class is simply a stl list<> of \ref JPEGFragment.
index 5d7c2232c89735c8e76718f7e5e00d4a24beb8d2..dfc3d89c868c2a738d7f377d5bfa015f7216e758 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmRLEFramesInfo.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/28 15:42:22 $
-  Version:   $Revision: 1.13 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.14 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -33,9 +33,9 @@ namespace gdcm
  *        Note: a classical image can be considered as the degenerated case
  *              of a multiframe image. In this case the collection is limited
  *              to a single individual frame.
- *        The informations on each frame are obtained during the parsing
- *        of a Document (refer to
- *          \ref Document::ComputeRLEInfo() ).
+ *        The informations on each frame are obtained during the pixel parsing
+ *        of a gdcm::File (refer to
+ *          \ref File::ComputeRLEInfo() ).
  *        They shall be used when (if necessary) decoding the frames.
  *
  *        This class is simply a stl list<> of \ref RLEFrame.
index bb90758205b3a6a805c339bce73da66db3987f4d..945ad0b2db8ec6d223fb04e5bc8e620eaf3df961 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/26 09:49:54 $
-  Version:   $Revision: 1.61 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.62 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -169,7 +169,7 @@ bool SQItem::AddEntry(DocEntry *entry)
  * @param   entryToRemove Entry to remove AND delete.
  * @return true if the entry was found and removed; false otherwise
  */
-bool SQItem::RemoveEntry( DocEntryentryToRemove)
+bool SQItem::RemoveEntry( DocEntry *entryToRemove)
 {
    for(ListDocEntry::iterator it = DocEntries.begin();
        it != DocEntries.end();
@@ -192,7 +192,7 @@ bool SQItem::RemoveEntry( DocEntry* entryToRemove)
  * @param   entryToRemove Entry to remove.
  * @return true if the entry was found and removed; false otherwise
  */
-bool SQItem::RemoveEntryNoDestroy(DocEntryentryToRemove)
+bool SQItem::RemoveEntryNoDestroy(DocEntry *entryToRemove)
 {
    for(ListDocEntry::iterator it = DocEntries.begin();
        it != DocEntries.end();
@@ -215,7 +215,7 @@ bool SQItem::RemoveEntryNoDestroy(DocEntry* entryToRemove)
  * \brief   Get the first Dicom entry while visiting the SQItem
  * \return  The first DocEntry if found, otherwhise 0
  */
-DocEntry * SQItem::GetFirstEntry()
+DocEntry *SQItem::GetFirstEntry()
 {
    ItDocEntries = DocEntries.begin();
    if (ItDocEntries != DocEntries.end())
index 03f1d679e9b85fb83f9cf63d416eb56efbe2a862..e2dad4e68f9b9d1f4c1d5cb85a260e052a0421b4 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmValEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/25 16:32:45 $
-  Version:   $Revision: 1.52 $
+  Date:      $Date: 2005/01/30 17:30:57 $
+  Version:   $Revision: 1.53 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -51,7 +51,6 @@ ValEntry::ValEntry(DocEntry *e)
    Copy(e);
 }
 
-
 /**
  * \brief   Canonical destructor.
  */
@@ -180,7 +179,6 @@ void ValEntry::Print(std::ostream &os, std::string const &)
  * \brief   Sets the std::string representable' value of a ValEntry
  * @param  val value to set 
  */
-
 void ValEntry::SetValue(std::string const &val)
 {
    // Integers have a special treatement for their length: