From 1a67d3dd70a5e6793a94a70d1b0f3ce594da00db Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Mon, 14 Mar 2016 08:58:17 +0000
Subject: [PATCH] Task #9052: Renamed createMetaData->init, and augment->fini

---
 RTCP/Cobalt/OutputProc/src/GPUProcIO.cc            |  4 ++--
 RTCP/Cobalt/OutputProc/src/MSWriter.cc             |  4 ++--
 RTCP/Cobalt/OutputProc/src/MSWriter.h              |  7 +++++--
 RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.cc   |  4 ++--
 RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.h    |  4 ++--
 RTCP/Cobalt/OutputProc/src/MSWriterDAL.cc          |  2 +-
 RTCP/Cobalt/OutputProc/src/MSWriterDAL.h           |  2 +-
 RTCP/Cobalt/OutputProc/src/OutputThread.cc         | 14 +++++++-------
 RTCP/Cobalt/OutputProc/src/OutputThread.h          |  4 ++--
 RTCP/Cobalt/OutputProc/src/SubbandWriter.cc        |  4 ++--
 RTCP/Cobalt/OutputProc/src/SubbandWriter.h         |  2 +-
 RTCP/Cobalt/OutputProc/test/tMSWriterCorrelated.cc |  3 ++-
 RTCP/Cobalt/OutputProc/test/tSubbandWriter.cc      |  4 +++-
 13 files changed, 32 insertions(+), 26 deletions(-)

diff --git a/RTCP/Cobalt/OutputProc/src/GPUProcIO.cc b/RTCP/Cobalt/OutputProc/src/GPUProcIO.cc
index 4eca0fdbab2..7cb62c7b0c8 100644
--- a/RTCP/Cobalt/OutputProc/src/GPUProcIO.cc
+++ b/RTCP/Cobalt/OutputProc/src/GPUProcIO.cc
@@ -294,9 +294,9 @@ bool process(Stream &controlStream)
     LOG_DEBUG_STR("Processing final meta data");
 
     for (size_t i = 0; i < subbandWriters.size(); ++i)
-      subbandWriters[i]->augment(finalMetaData);
+      subbandWriters[i]->fini(finalMetaData);
     for (size_t i = 0; i < tabWriters.size(); ++i)
-      tabWriters[i]->augment(finalMetaData);
+      tabWriters[i]->fini(finalMetaData);
 
     /*
      * LTA FEEDBACK
diff --git a/RTCP/Cobalt/OutputProc/src/MSWriter.cc b/RTCP/Cobalt/OutputProc/src/MSWriter.cc
index 826c6b42215..1c354398df6 100644
--- a/RTCP/Cobalt/OutputProc/src/MSWriter.cc
+++ b/RTCP/Cobalt/OutputProc/src/MSWriter.cc
@@ -42,11 +42,11 @@ namespace LOFAR
     {
     }
 
-    void MSWriter::createMetaData()
+    void MSWriter::init()
     {
     }
 
-    void MSWriter::augment(const FinalMetaData &finalMetaData)
+    void MSWriter::fini(const FinalMetaData &finalMetaData)
     {
       (void)finalMetaData;
     }
diff --git a/RTCP/Cobalt/OutputProc/src/MSWriter.h b/RTCP/Cobalt/OutputProc/src/MSWriter.h
index 82b6ed55750..eb322a9972e 100644
--- a/RTCP/Cobalt/OutputProc/src/MSWriter.h
+++ b/RTCP/Cobalt/OutputProc/src/MSWriter.h
@@ -39,9 +39,12 @@ namespace LOFAR
 
       virtual void write(StreamableData *) = 0;
 
-      virtual void createMetaData();
+      // init() initialises the meta data,
+      // and will be called in parallel to write().
+      virtual void init();
 
-      virtual void augment(const FinalMetaData &finalMetaData);
+      // fini() will be called after init() and write().
+      virtual void fini(const FinalMetaData &finalMetaData);
 
       virtual size_t getDataSize();
 
diff --git a/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.cc b/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.cc
index bcac57dd52d..52004bb85dc 100644
--- a/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.cc
+++ b/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.cc
@@ -71,7 +71,7 @@ namespace LOFAR
     }
 
 
-    void MSWriterCorrelated::createMetaData()
+    void MSWriterCorrelated::init()
     {
       // Creaate MeasurementSet
 #if defined HAVE_AIPSPP
@@ -126,7 +126,7 @@ namespace LOFAR
     }
 
 
-    void MSWriterCorrelated::augment(const FinalMetaData &finalMetaData)
+    void MSWriterCorrelated::fini(const FinalMetaData &finalMetaData)
     {
       ScopedLock sl(MeasurementSetFormat::sharedMutex);
 
diff --git a/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.h b/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.h
index 243e60d567c..99f2556bd93 100644
--- a/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.h
+++ b/RTCP/Cobalt/OutputProc/src/MSWriterCorrelated.h
@@ -43,11 +43,11 @@ namespace LOFAR
       MSWriterCorrelated(const std::string &logPrefix, const std::string &msName, const Parset &parset, unsigned subbandIndex);
       ~MSWriterCorrelated();
 
-      virtual void createMetaData();
+      virtual void init();
 
       virtual void write(StreamableData *data);
 
-      virtual void augment(const FinalMetaData &finalMetaData);
+      virtual void fini(const FinalMetaData &finalMetaData);
 
     protected:
       const std::string itsLogPrefix;
diff --git a/RTCP/Cobalt/OutputProc/src/MSWriterDAL.cc b/RTCP/Cobalt/OutputProc/src/MSWriterDAL.cc
index 5c7399f39cd..12bd714764a 100644
--- a/RTCP/Cobalt/OutputProc/src/MSWriterDAL.cc
+++ b/RTCP/Cobalt/OutputProc/src/MSWriterDAL.cc
@@ -114,7 +114,7 @@ namespace LOFAR
     }
 
     template <typename T,unsigned DIM>
-    void MSWriterDAL<T,DIM>::createMetaData()
+    void MSWriterDAL<T,DIM>::init()
     {
       string h5filename = forceextension(itsFilename, ".h5");
       string rawfilename = forceextension(itsFilename, ".raw");
diff --git a/RTCP/Cobalt/OutputProc/src/MSWriterDAL.h b/RTCP/Cobalt/OutputProc/src/MSWriterDAL.h
index dff266f738c..8f9c552cbde 100644
--- a/RTCP/Cobalt/OutputProc/src/MSWriterDAL.h
+++ b/RTCP/Cobalt/OutputProc/src/MSWriterDAL.h
@@ -45,7 +45,7 @@ namespace LOFAR
       MSWriterDAL(const std::string &filename, const Parset &parset, unsigned fileno);
       ~MSWriterDAL();
 
-      virtual void createMetaData();
+      virtual void init();
 
       virtual void write(StreamableData *data);
 
diff --git a/RTCP/Cobalt/OutputProc/src/OutputThread.cc b/RTCP/Cobalt/OutputProc/src/OutputThread.cc
index 6fb2e8230a6..5e0237bd2e7 100644
--- a/RTCP/Cobalt/OutputProc/src/OutputThread.cc
+++ b/RTCP/Cobalt/OutputProc/src/OutputThread.cc
@@ -161,26 +161,26 @@ namespace LOFAR
     }
 
 
-    template<typename T> void OutputThread<T>::createMetaData()
+    template<typename T> void OutputThread<T>::init()
     {
       try {
-        // augment the data product
+        // fini the data product
         ASSERT(itsWriter.get());
 
-        itsWriter->createMetaData();
+        itsWriter->init();
       } catch (Exception &ex) {
         LOG_ERROR_STR(itsLogPrefix << "Could not create meta data: " << ex);
       }
     }
 
 
-    template<typename T> void OutputThread<T>::augment( const FinalMetaData &finalMetaData )
+    template<typename T> void OutputThread<T>::fini( const FinalMetaData &finalMetaData )
     {
       try {
-        // augment the data product
+        // fini the data product
         ASSERT(itsWriter.get());
 
-        itsWriter->augment(finalMetaData);
+        itsWriter->fini(finalMetaData);
       } catch (Exception &ex) {
         LOG_ERROR_STR(itsLogPrefix << "Could not add final meta data: " << ex);
       }
@@ -216,7 +216,7 @@ namespace LOFAR
         }
 
 #       pragma omp section
-        createMetaData();
+        init();
       }
     }
 
diff --git a/RTCP/Cobalt/OutputProc/src/OutputThread.h b/RTCP/Cobalt/OutputProc/src/OutputThread.h
index 71798074087..106fe70ae3b 100644
--- a/RTCP/Cobalt/OutputProc/src/OutputThread.h
+++ b/RTCP/Cobalt/OutputProc/src/OutputThread.h
@@ -70,10 +70,10 @@ namespace LOFAR
       void           cleanUp() const;
 
       // Create the metadata files in parallel to writing the data
-      void           createMetaData();
+      void           init();
 
       // Add FinalMetaData to the data container.
-      void           augment(const FinalMetaData &finalMetaData);
+      void           fini(const FinalMetaData &finalMetaData);
 
       // Return the LTA feedback produced by this writer.
       ParameterSet feedbackLTA() const;
diff --git a/RTCP/Cobalt/OutputProc/src/SubbandWriter.cc b/RTCP/Cobalt/OutputProc/src/SubbandWriter.cc
index 33fd6904eac..d2a1e12dda5 100644
--- a/RTCP/Cobalt/OutputProc/src/SubbandWriter.cc
+++ b/RTCP/Cobalt/OutputProc/src/SubbandWriter.cc
@@ -67,9 +67,9 @@ namespace LOFAR
     }
 
 
-    void SubbandWriter::augment( const FinalMetaData &finalMetaData )
+    void SubbandWriter::fini( const FinalMetaData &finalMetaData )
     {
-      itsOutputThread.augment(finalMetaData);
+      itsOutputThread.fini(finalMetaData);
     }
 
 
diff --git a/RTCP/Cobalt/OutputProc/src/SubbandWriter.h b/RTCP/Cobalt/OutputProc/src/SubbandWriter.h
index 65aeccb98c4..cc3b43767cb 100644
--- a/RTCP/Cobalt/OutputProc/src/SubbandWriter.h
+++ b/RTCP/Cobalt/OutputProc/src/SubbandWriter.h
@@ -54,7 +54,7 @@ namespace LOFAR
 
       void process();
 
-      void augment(const FinalMetaData &finalMetaData);
+      void fini(const FinalMetaData &finalMetaData);
 
       ParameterSet feedbackLTA() const;
 
diff --git a/RTCP/Cobalt/OutputProc/test/tMSWriterCorrelated.cc b/RTCP/Cobalt/OutputProc/test/tMSWriterCorrelated.cc
index ffdccf0b118..0b3e702615e 100644
--- a/RTCP/Cobalt/OutputProc/test/tMSWriterCorrelated.cc
+++ b/RTCP/Cobalt/OutputProc/test/tMSWriterCorrelated.cc
@@ -40,6 +40,7 @@ int main()
   {
     // Create MeasurementSet
     MSWriterCorrelated writer("", "tMSWriterCorrelated.in_1/SB000.MS", parset, 0);
+    writer.init();
 
     // Write some data
     CorrelatedData data(parset.nrMergedStations(), parset.settings.correlator.nrChannels, parset.settings.correlator.nrSamplesPerIntegration(), heapAllocator, 512);
@@ -64,7 +65,7 @@ int main()
 
     fmd.brokenRCUsAtBegin.push_back(rcu);
 
-    writer.augment(fmd);
+    writer.fini(fmd);
   }
 
   return 0;
diff --git a/RTCP/Cobalt/OutputProc/test/tSubbandWriter.cc b/RTCP/Cobalt/OutputProc/test/tSubbandWriter.cc
index f68e6fea6d0..527aa4449d4 100644
--- a/RTCP/Cobalt/OutputProc/test/tSubbandWriter.cc
+++ b/RTCP/Cobalt/OutputProc/test/tSubbandWriter.cc
@@ -97,6 +97,7 @@ SUITE(SubbandWriter)
     {
 #     pragma omp section
       {
+        w.init();
         w.process();
       }
 
@@ -139,6 +140,7 @@ SUITE(SubbandWriter)
     {
 #     pragma omp section
       {
+        w.init();
         w.process();
       }
 
@@ -159,7 +161,7 @@ SUITE(SubbandWriter)
     finalMetaData.brokenRCUsAtBegin.push_back( FinalMetaData::BrokenRCU("CS001", "LBA", brokenAntennaBefore, "2012-01-01 12:34") );
     finalMetaData.brokenRCUsDuring.push_back( FinalMetaData::BrokenRCU("CS001", "LBA", brokenAntennaDuring, "2013-01-01 00:30") );
 
-    w.augment(finalMetaData);
+    w.fini(finalMetaData);
 
     // list failures BEFORE obs
     {
-- 
GitLab