RStationListManager.cc

Go to the documentation of this file.

#include <boost/format.hpp>
#include <boost/lexical_cast.hpp>

#include <det/Detector.h>

#include <rdet/RDetector.h>
#include <rdet/RStationListManager.h>

#include <utl/UTCDateTime.h>

using namespace rdet;
using namespace det;
using namespace std;
using namespace utl;
using namespace ::boost::multi_index;


namespace rdet {

// specialization for "int"
template<>
VManager::Status
RStationListManager::GetData(int& returnData,
                             const string& componentProperty,
                             const VManager::IndexMap& componentIndex)
  const
{
  const int id = GetStationId(componentIndex);
  const StationIdIndex& idIndex = fStations.get<ByStationId>();
  const StationIdIndex::const_iterator sIt = idIndex.find(id);

  if (sIt == idIndex.end())
    return VManager::eNotFound;

  if (componentProperty == "inGrid")
    returnData = sIt->fInGrid;
  else if (componentProperty == "zone")
    returnData = sIt->fZone;
  else if (componentProperty == "nChannels")
    returnData = sIt->fNChannels;
  else if (componentProperty == "firstChannelId")
    returnData = sIt->fFirstChannelId;
  else if (componentProperty == "lastChannelId")
    returnData = sIt->fLastChannelId;
  else if (componentProperty == "virtual")
    returnData = sIt->fIsVirtual;
  else
    return VManager::eNotFound;

  return VManager::eFound;
}


// specialization for "double"
template<>
VManager::Status
RStationListManager::GetData(double& returnData,
                             const string& componentProperty,
                             const VManager::IndexMap& componentIndex)
  const
{
  const int id = GetStationId(componentIndex);
  const StationIdIndex& idIndex = fStations.get<ByStationId>();
  const StationIdIndex::const_iterator sIt = idIndex.find(id);

  if (sIt == idIndex.end())
    return VManager::eNotFound;

  if (componentProperty == "northing")
    returnData = sIt->fNorthing;
  else if (componentProperty == "easting")
    returnData = sIt->fEasting;
  else if (componentProperty == "altitude")
    returnData = sIt->fAltitude;
  else
    return VManager::eNotFound;

  return VManager::eFound;
}


// specialization for "string"
template<>
VManager::Status
RStationListManager::GetData(string& returnData,
                             const string& componentProperty,
                             const VManager::IndexMap& componentIndex)
  const
{
  const int id = GetStationId(componentIndex);
  const StationIdIndex& idIndex = fStations.get<ByStationId>();
  const StationIdIndex::const_iterator sIt = idIndex.find(id);

  if (sIt == idIndex.end())
    return VManager::eNotFound;

  if (componentProperty == "name")
    returnData = sIt->fName;
  else if (componentProperty == "commission")
    returnData = sIt->fCommissionTime;
  else if (componentProperty == "decommission")
    returnData = sIt->fDecommissionTime; 
  else if (componentProperty == "band")
    returnData = sIt->fBand;
  else if (componentProperty == "ellipsoid")
    returnData = sIt->fEllipsoid;
  else if (componentProperty == "source")
    returnData = sIt->fSource;
  else
    return VManager::eNotFound;

  return VManager::eFound;
}


// specialization for "vector<int>"
template<>
VManager::Status
RStationListManager::GetData(vector<int>& returnData,
                             const string& componentProperty,
                             const VManager::IndexMap& /*componentIndex*/)
  const
{
  /* For the AugerPrime Radio Detector (RD), the station list is provided
     by the SStationListManager (see RDetector.cc). Only if that is _not_ 
     explicitly configured (i.e. !rDetector.AddStationListFromSManager())
     return a eNotFound for an empty station list. */
  if (fStations.empty() && !Detector::GetInstance().GetRDetector().AddStationListFromSManager())
    return VManager::eNotFound;

  if (componentProperty == "fullStationList")
    GetFullStationList(returnData);
  else
    return VManager::eNotFound;

  return VManager::eFound;
}


// specialization for "vector<vector<int> >"
template<>
VManager::Status
RStationListManager::GetData(vector<vector<int> >& /*returnData*/,
                             const string& /*componentProperty*/,
                             const VManager::IndexMap&)
  const
{
  if (fStations.empty())
    return VManager::eNotFound;

  return VManager::eFound;
}


bool
RStationListManager::ConditionalAddStationData(RStationListManager::StationData& station)
{
  if (HasStationData(station.fId))
    return false;

  const TimeStamp commission =
    boost::lexical_cast<UTCDateTime>(station.fCommissionTime).GetTimeStamp();
  const TimeStamp decommission =
    boost::lexical_cast<UTCDateTime>(station.fDecommissionTime).GetTimeStamp();
  station.fCommissionTimeRange = TimeRange(commission, decommission);
  fStations.insert(station);
  return true;
}


void
RStationListManager::AddOrReplaceStationData(RStationListManager::StationData& station)
{
  const TimeStamp commission =
    boost::lexical_cast<UTCDateTime>(station.fCommissionTime).GetTimeStamp();
  const TimeStamp decommission =
    boost::lexical_cast<UTCDateTime>(station.fDecommissionTime).GetTimeStamp();
  station.fCommissionTimeRange = TimeRange(commission, decommission);
  
  if (HasStationData(station.fId)) {
    // if station already exists, find and replace
    StationIdIndex& station_by_id = fStations.get<ByStationId>();
    StationIdIndex::iterator station_to_be_replaced = station_by_id.find(station.fId);
    station_by_id.replace(station_to_be_replaced, station);
  } else {
    fStations.insert(station);
  }
}


void
RStationListManager::ClearStations(const std::string source_type)
{
  std::vector<int> remove_station_ids;
  for (auto& station : fStations) {
    if (station.fSource == source_type)
      remove_station_ids.push_back(station.fId);
  }

  for (auto& id : remove_station_ids)
    fStations.erase(id);
}



bool
RStationListManager::RemoveStationData(RStationListManager::StationData& station)
{
  if (HasStationData(station.fId)) {
    // if station already exists, find and replace
    StationIdIndex& station_by_id = fStations.get<ByStationId>();
    StationIdIndex::iterator station_to_be_removed = station_by_id.find(station.fId);
    station_by_id.erase(station_to_be_removed);
    return true;
  } else {
    return false;
  }
}


bool
RStationListManager::HasStationData(const int id)
  const
{
  const StationIdIndex& idIndex = fStations.get<ByStationId>();
  return idIndex.find(id) != idIndex.end();
}


void
RStationListManager::GetFullStationList(vector<int>& returnList)
  const
{
  returnList.clear();
  const StationIdIndex& idIndex = fStations.get<ByStationId>();
  for (StationIdIndex::const_iterator sIt = idIndex.begin(); sIt != idIndex.end(); ++sIt)
    returnList.push_back(sIt->fId);
}



string
StringToXMLString(const string& str)
{
  ostringstream res;

  for (string::const_iterator it = str.begin(); it != str.end(); ++it)
    switch (*it) {
    // replace '&' with "&amp;"
    case '&':
      res << "and";
      break;
    default:
      res << *it;
    }

  return res.str();
}


bool
RStationListManager::DumpXML(ostream& output, const string& indent)
  const
{
  if (fStations.empty())
    return false;

  boost::format stationFmt(
    "%1%<station id=\"%2%\">\n"
    "%1%  <northing unit=\"meter\"> %|3$.2f| </northing>\n"
    "%1%  <easting unit=\"meter\"> %|4$.2f| </easting>\n"
    "%1%  <altitude unit=\"meter\"> %|5$.2f| </altitude>\n"
    "%1%  <name> %6% </name>\n"
    "%1%  <commission> %7% </commission>\n"
    "%1%  <decommission> %8% </decommission>\n"
    "%1%  <inGrid> %9% </inGrid>\n"
    "%1%  <ellipsoid> %13% </ellipsoid>\n"
    "%1%  <zone> %14% </zone>\n"
    "%1%  <band> %15% </band>\n"
    "%1%</station>\n"
  );

  const StationIdIndex& sIndex = fStations.get<ByStationId>();
  for (StationIdIndex::const_iterator sIt = sIndex.begin();
       sIt != sIndex.end(); ++sIt)
    output
      << stationFmt
        % indent
        % sIt->fId
        % sIt->fNorthing
        % sIt->fEasting
        % sIt->fAltitude
        % StringToXMLString(sIt->fName)
        % sIt->fCommissionTime
        % sIt->fDecommissionTime
        % sIt->fInGrid
        % sIt->fEllipsoid
        % sIt->fZone
        % sIt->fBand
      << '\n';

  return true;
}

}