* Builder/ : add something to facilitate the RPM creation of gdcm

[gdcm.git] / src / gdcmTS.cxx

diff --git a/src/gdcmTS.cxx b/src/gdcmTS.cxx
index 348f7e003c496a68942de9b0b5261eeb1fa3afc0..598c92dbfdd97e2a05102cbf6052db878abc4056 100644 (file)
--- a/src/gdcmTS.cxx
+++ b/src/gdcmTS.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmTS.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/23 10:12:34 $
-  Version:   $Revision: 1.38 $
+  Date:      $Date: 2005/02/11 15:22:18 $
+  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
@@ -28,12 +28,13 @@
 // TODO
 // a lot of troubles expected with TS : 1.2.840.113619.5.2
 // Implicit VR - Big Endian
-// see : http://www.gemedicalsystemseurope.com/euen/it_solutions/pdf/lsqxi_rev2.pdf
+// http://www.gemedicalsystemseurope.com/euen/it_solutions/pdf/lsqxi_rev2.pdf
 // 
 
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
+/// \brief Transfer Syntaxes gdcm deals with (internal use onky)
 static const char *SpecialStrings[] =  {
   // Implicit VR Little Endian
   "1.2.840.10008.1.2",
@@ -57,7 +58,8 @@ static const char *SpecialStrings[] =  {
   "1.2.840.10008.1.2.4.55",
   // JPEG Lossless, Non-Hierarchical (Process 14)
   "1.2.840.10008.1.2.4.57",
-  // JPEG Lossless, Hierarchical, First-Order Prediction (Process 14, [Selection Value 1])
+  // JPEG Lossless, Hierarchical, First-Order Prediction (Process 14,
+  //                                                       [Selection Value 1])
   "1.2.840.10008.1.2.4.70",
   // JPEG-LS Lossless Image Compression
   "1.2.840.10008.1.2.4.80",
@@ -73,7 +75,11 @@ static const char *SpecialStrings[] =  {
   "Unknown Transfer Syntax"
 };
 
+//-----------------------------------------------------------------------------
+/// \brief auto generated function, to fill up the Dicom Dictionnary,
+///       if relevant file is not found on user's disk
 void FillDefaultTSDict(TSHT &ts);
+
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 TS::TS() 
@@ -82,7 +88,7 @@ TS::TS()
    std::ifstream from(filename.c_str());
    if( !from )
    {
-      gdcmVerboseMacro("Can't open dictionary" << filename.c_str());
+      gdcmWarningMacro("Can't open dictionary" << filename.c_str());
       FillDefaultTSDict( TsMap );
    }
    else
@@ -105,39 +111,25 @@ TS::TS()
    }
 }
 
-//-----------------------------------------------------------------------------
 TS::~TS() 
 {
    TsMap.clear();
 }
 
-//-----------------------------------------------------------------------------
-// Print
-/**
- * \brief   Print all 
- * @param   os The output stream to be written to.
- */
-void TS::Print(std::ostream &os) 
-{
-   std::ostringstream s;
-
-   for (TSHT::const_iterator it = TsMap.begin(); it != TsMap.end(); ++it)
-   {
-      s << "TS : " << it->first << " = " << it->second << std::endl;
-   }
-   os << s.str();
-}
-
 //-----------------------------------------------------------------------------
 // Public
+
+/// \brief returns occurence number of the given key
 int TS::Count(TSKey const &key) 
 {
    return TsMap.count(key);
 }
 
-TSAtr const & TS::GetValue(TSKey const &key) 
+/// \brief returns the human reabable value of a Transfer Synatx string 
+TSAtr const &TS::GetValue(TSKey const &key) 
 {
-   // First thing clean up the string sometime the transfer syntax is padded with spaces
+   // First thing clean up the string 
+   // (sometime the transfer syntax is padded with spaces)
    std::string copy = key;
    while ( copy.size() && !isdigit((unsigned char)copy[copy.size()-1]) )
    {
@@ -227,6 +219,7 @@ bool TS::IsJPEGLossy(TSKey const &key)
    }
    return r;
 }
+
 /**
  * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a JPEG2000 one
@@ -314,5 +307,21 @@ const char* TS::GetSpecialTransferSyntax(SpecialType t)
 // Private
 
 //-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief   Print all 
+ * @param   os The output stream to be written to.
+ */
+void TS::Print(std::ostream &os) 
+{
+   std::ostringstream s;
 
+   for (TSHT::const_iterator it = TsMap.begin(); it != TsMap.end(); ++it)
+   {
+      s << "TS : " << it->first << " = " << it->second << std::endl;
+   }
+   os << s.str();
+}
+
+//-----------------------------------------------------------------------------
 } // end namespace gdcm