Changeset 667 for XIOS/trunk/src/node/domain.cpp

Timestamp:

08/24/15 14:53:33 (9 years ago)

Author:

mhnguyen

Message:

Clearing some redundant codes and add some comments

Test
No

File:

• XIOS/trunk/src/node/domain.cpp (modified) (24 diffs)

XIOS/trunk/src/node/domain.cpp

@@ -169 +169 @@
       else if (!i_index.isEmpty())
       {
-        ibegin = i_index(0);
+        if (ibegin.isEmpty()) ibegin = i_index(0);
       }
 
@@ -192 +192 @@
      else if (!j_index.isEmpty())
      {
-       jbegin = j_index(0);
+       if (jbegin.isEmpty()) jbegin = j_index(0);
      }
 
@@ -208 +208 @@
    void CDomain::checkMask(void)
    {
-      using namespace std;
-
-      int ibegin_mask = 0,
-          jbegin_mask = 0,
-          iend_mask = ibegin.getValue() + ni.getValue() - 1,
-          jend_mask = jbegin.getValue() + nj.getValue() - 1;
-
       if (!mask_1d.isEmpty() && !mask_2d.isEmpty())
         ERROR("CDomain::checkMask(void)",
@@ -644 +637 @@
 
    //----------------------------------------------------------------
-   // Divide function checkAttributes into 2 seperate onescheckBounds
+   // Divide function checkAttributes into 2 seperate ones
    // This function only checks all attributes of current domain
    void CDomain::checkAttributesOnClient()
@@ -682 +675 @@
        if (hasLonLat || hasArea) sendLonLatArea();
      }
-
      this->isChecked = true;
    }
@@ -877 +869 @@
   }
 
+  /*!
+    Send index from client to server(s)
+  */
   void CDomain::sendIndex()
   {
@@ -923 +918 @@
   }
 
+  /*!
+    Send area from client to server(s)
+  */
   void CDomain::sendArea()
   {
@@ -965 +963 @@
   }
 
+  /*!
+    Send longitude and latitude from client to servers
+    Each client send long and lat information to corresponding connected server(s).
+    Because longitude and latitude are optional, this function only called if latitude and longitude exist
+  */
   void CDomain::sendLonLat()
   {
@@ -1042 +1045 @@
   }
 
-
+  /*!
+    Send some optional information to server(s)
+    In the future, this function can be extended with more optional information to send
+  */
   void CDomain::sendLonLatArea(void)
   {
@@ -1085 +1091 @@
   }
 
+  /*!
+    Receive attributes event from clients(s)
+    \param[in] event event contain info about rank and associated attributes
+  */
   void CDomain::recvServerAttribut(CEventServer& event)
   {
@@ -1093 +1103 @@
   }
 
+  /*!
+    Receive attributes from client(s): zoom info and begin and n of each server
+    \param[in] rank rank of client source
+    \param[in] buffer message containing attributes info
+  */
   void CDomain::recvServerAttribut(CBufferIn& buffer)
   {
@@ -1130 +1145 @@
   }
 
+  /*!
+    Receive index event from clients(s)
+    \param[in] event event contain info about rank and associated index
+  */
   void CDomain::recvIndex(CEventServer& event)
   {
@@ -1142 +1161 @@
   }
 
+  /*!
+    Receive index information from client(s)
+    \param[in] rank rank of client source
+    \param[in] buffer message containing index info
+  */
   void CDomain::recvIndex(int rank, CBufferIn& buffer)
   {
@@ -1149 +1173 @@
   }
 
+  /*!
+    Receive longitude event from clients(s)
+    \param[in] event event contain info about rank and associated longitude
+  */
   void CDomain::recvLon(CEventServer& event)
   {
@@ -1161 +1189 @@
   }
 
+  /*!
+    Receive longitude information from client(s)
+    \param[in] rank rank of client source
+    \param[in] buffer message containing longitude info
+  */
   void CDomain::recvLon(int rank, CBufferIn& buffer)
   {
@@ -1184 +1217 @@
   }
 
+  /*!
+    Receive latitude event from clients(s)
+    \param[in] event event contain info about rank and associated latitude
+  */
   void CDomain::recvLat(CEventServer& event)
   {
@@ -1196 +1233 @@
   }
 
+  /*!
+    Receive latitude information from client(s)
+    \param[in] rank rank of client source
+    \param[in] buffer message containing latitude info
+  */
   void CDomain::recvLat(int rank, CBufferIn& buffer)
   {
@@ -1219 +1261 @@
   }
 
+  /*!
+    Receive area event from clients(s)
+    \param[in] event event contain info about rank and associated area
+  */
   void CDomain::recvArea(CEventServer& event)
   {
@@ -1231 +1277 @@
   }
 
+  /*!
+    Receive area information from client(s)
+    \param[in] rank rank of client source
+    \param[in] buffer message containing area info
+  */
   void CDomain::recvArea(int rank, CBufferIn& buffer)
   {
@@ -1247 +1298 @@
   }
 
+  /*!
+    Check whether a domain has transformation
+    \return true if domain has transformation
+  */
   bool CDomain::hasTransformation()
   {
@@ -1252 +1307 @@
   }
 
+  /*!
+    Set transformation for current domain. It's the method to move transformation in hierarchy
+    \param [in] domTrans transformation on domain
+  */
   void CDomain::setTransformations(const TransMapTypes& domTrans)
   {
@@ -1257 +1316 @@
   }
 
+  /*!
+    Get all transformation current domain has
+    \return all transformation
+  */
   CDomain::TransMapTypes CDomain::getAllTransformations(void)
   {
@@ -1276 +1339 @@
   }
 
+  /*!
+    A current domain will go up the hierarchy to find out the domain from which it has transformation
+  */
   void CDomain::solveInheritanceTransformation()
   {
@@ -1296 +1362 @@
   }
 
+  /*!
+    Parse children nodes of a domain in xml file.
+    Whenver there is a new transformation, its type and name should be added into this function
+    \param node child node to process
+  */
   void CDomain::parse(xml::CXMLNode & node)
   {