]> Creatis software - gdcm.git/blobdiff - src/gdcmUtil.cxx
doxygenation
[gdcm.git] / src / gdcmUtil.cxx
index fb1f87fb248565e7647eb571759083d65cd66a4e..897899eb47db15955ea9bc67f2edf50e05c5cf4c 100644 (file)
 gdcmDebug dbg;
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup gdcmDebug
+ * \brief   constructor
+ * @param level debug level
+ */ 
+
 gdcmDebug::gdcmDebug(int level) {
    DebugLevel = level;
 }
 
+/**
+ * \ingroup gdcmDebug
+ * \brief   Verbose 
+ * @param Level level
+ * @param Msg1 first message part
+ * @param Msg2 second message part 
+ */
 void gdcmDebug::Verbose(int Level, const char * Msg1, const char * Msg2) {
    if (Level > DebugLevel)
       return ;
    std::cerr << Msg1 << ' ' << Msg2 << std::endl;
 }
 
+/**
+ * \ingroup gdcmDebug
+ * \brief   Error 
+ * @param Test test
+ * @param Msg1 first message part
+ * @param Msg2 second message part 
+ */
 void gdcmDebug::Error( bool Test, const char * Msg1, const char * Msg2) {
    if (!Test)
       return;
@@ -28,13 +48,28 @@ void gdcmDebug::Error( bool Test, const char * Msg1, const char * Msg2) {
    Exit(1);
 }
 
+/**
+ * \ingroup gdcmDebug
+ * \brief   Error 
+ * @param Msg1 first message part
+ * @param Msg2 second message part
+ * @param Msg3 Third message part  
+ */
 void gdcmDebug::Error(const char* Msg1, const char* Msg2,
                       const char* Msg3) {
    std::cerr << Msg1 << ' ' << Msg2 << ' ' << Msg3 << std::endl;
    Exit(1);
 }
 
-void gdcmDebug::Assert(int Level, bool Test,
+/**
+ * \ingroup gdcmDebug
+ * \brief   Assert 
+ * @param Level level 
+ * @param Test test
+ * @param Msg1 first message part
+ * @param Msg2 second message part
+ */
+ void gdcmDebug::Assert(int Level, bool Test,
                  const char * Msg1, const char * Msg2) {
    if (Level > DebugLevel)
       return ;
@@ -42,6 +77,11 @@ void gdcmDebug::Assert(int Level, bool Test,
       std::cerr << Msg1 << ' ' << Msg2 << std::endl;
 }
 
+/**
+ * \ingroup gdcmDebug
+ * \brief   Exit 
+ * @param a return code 
+ */
 void gdcmDebug::Exit(int a) {
 #ifdef __GNUC__
    std::exit(a);
@@ -52,23 +92,40 @@ void gdcmDebug::Exit(int a) {
 }
 
 //-----------------------------------------------------------------------------
-gdcmVR      *gdcmGlobal::VR    = (gdcmVR *)0;
-gdcmTS      *gdcmGlobal::TS    = (gdcmTS *)0;
-gdcmDictSet *gdcmGlobal::Dicts = (gdcmDictSet *)0;
+/// Pointer to a container, holding *all* the Dicom Dictionaries
+gdcmDictSet         *gdcmGlobal::Dicts  = (gdcmDictSet *)0;
+/// Pointer to a H table containing the 'Value Representations'
+gdcmVR              *gdcmGlobal::VR     = (gdcmVR *)0;
+/// Pointer to a H table containing the Transfer Syntax codes and their english description 
+gdcmTS              *gdcmGlobal::TS     = (gdcmTS *)0;
+/// Pointer to a H table containing the Dicom Elements necessary to describe each part of a DICOMDIR 
+gdcmDicomDirElement *gdcmGlobal::ddElem = (gdcmDicomDirElement *)0;
+/// gdcm Glob
 gdcmGlobal gdcmGlob;
 
+
+/**
+ * \ingroup gdcmGlobal
+ * \brief   constructor : populates the
+ */
 gdcmGlobal::gdcmGlobal(void) {
-   if (VR || TS || Dicts)
+   if (VR || TS || Dicts || ddElem)
       dbg.Verbose(0, "gdcmGlobal::gdcmGlobal : VR or TS or Dicts already allocated");
-   VR = new gdcmVR();
-   TS = new gdcmTS();
-   Dicts = new gdcmDictSet();
+   Dicts  = new gdcmDictSet();
+   VR     = new gdcmVR();
+   TS     = new gdcmTS();
+   ddElem = new gdcmDicomDirElement();
 }
 
+/**
+ * \ingroup gdcmGlobal
+ * \brief   canonical destructor 
+ */
 gdcmGlobal::~gdcmGlobal() {
+   delete Dicts;
    delete VR;
    delete TS;
-   delete Dicts;
+   delete ddElem;
 }
 
 gdcmVR *gdcmGlobal::GetVR(void) {
@@ -83,7 +140,17 @@ gdcmDictSet *gdcmGlobal::GetDicts(void) {
    return Dicts;
 }
 
+gdcmDicomDirElement *gdcmGlobal::GetDicomDirElements(void) {
+   return ddElem;
+}
+
 //-----------------------------------------------------------------------------
+// Here are some usefull functions, belonging to NO class,
+// dealing with strings, file names, etc
+// that can be called from anywhere
+// by whomsoever they can help.
+//-----------------------------------------------------------------------------
+
 // Because is not yet available in g++2.96
 std::istream& eatwhite(std::istream& is) {
    char c;
@@ -112,7 +179,10 @@ void Tokenize (const std::string& str,
 
 
 ///////////////////////////////////////////////////////////////////////////
-// to prevent a flashing screen when non-printable character
+/*
+ * \brief  to prevent a flashing screen when non-printable character
+ * @param 
+ */
 char *_cleanString(char *v) {
    char *d;
    int i, l;
@@ -126,9 +196,11 @@ char *_cleanString(char *v) {
    return v;
 }
 
-
 ///////////////////////////////////////////////////////////////////////////
-// to prevent a flashing screen when non-printable character
+/*
+ * \brief   to prevent a flashing screen when non-printable character
+ * @param 
+ */
 std::string _CreateCleanString(std::string s) {
    std::string str=s;
 
@@ -146,3 +218,62 @@ std::string _CreateCleanString(std::string s) {
 
    return(str);
 }
+
+///////////////////////////////////////////////////////////////////////////
+/*
+ * \brief   Add a SEPARATOR to the end of the name is necessary
+ * @param   
+ */
+void NormalizePath(std::string &name)
+{
+const char SEPARATOR_X      = '/';
+const char SEPARATOR_WIN    = '\\';
+const std::string SEPARATOR = "/";
+   int size=name.size();
+   if((name[size-1]!=SEPARATOR_X)&&(name[size-1]!=SEPARATOR_WIN))
+   {
+      name+=SEPARATOR;
+   }
+}
+
+///////////////////////////////////////////////////////////////////////////
+/*
+ * \brief   Get the (directory) path from a full path file name
+ * @param 
+ */
+std::string GetPath(std::string &fullName)
+{
+   int pos1=fullName.rfind("/");
+   int pos2=fullName.rfind("\\");
+   if(pos1>pos2)
+      fullName.resize(pos1);
+   else
+      fullName.resize(pos2);
+   return(fullName);
+}
+
+///////////////////////////////////////////////////////////////////////////
+/*
+ * \brief   Get the (last) name of a full path file name
+ * @param 
+ */
+std::string GetName(std::string &fullName)
+{   
+  int fin=fullName.length()-1;
+  char a =fullName.c_str()[fin];
+  if (a == '/' || a == '\\') {
+     fin--;
+  }
+  int deb;
+  for (int i=fin;i!=0;i--) {
+     if (fullName.c_str()[i] == '/' || fullName.c_str()[i] == '\\')  
+        break;
+      deb = i;
+  }    
+
+  std::string lastName;
+  for (int j=deb;j<fin+1;j++)
+    lastName=lastName+fullName.c_str()[j];
+
+  return(lastName);
+}