SMWebPageHelper.h

Go to the documentation of this file.

// $Id: SMWebPageHelper.h,v 1.4 2011/11/18 14:47:56 mommsen Exp $

#ifndef EventFilter_StorageManager_SMWebPageHelper_h
#define EventFilter_StorageManager_SMWebPageHelper_h

#include <string>
#include <map>

#include "toolbox/mem/Pool.h"
#include "xdaq/ApplicationDescriptor.h"
#include "xgi/Output.h"

#include "EventFilter/Utilities/interface/Css.h"

#include "EventFilter/StorageManager/interface/ConsumerWebPageHelper.h"
#include "EventFilter/StorageManager/interface/RegistrationCollection.h"
#include "EventFilter/StorageManager/interface/SharedResources.h"
#include "EventFilter/StorageManager/interface/StatisticsReporter.h"
#include "EventFilter/StorageManager/interface/Utils.h"
#include "EventFilter/StorageManager/interface/WebPageHelper.h"
#include "EventFilter/StorageManager/interface/XHTMLMaker.h"


namespace stor {

  class DQMEventMonitorCollection;
  class FilesMonitorCollection;
  class FragmentMonitorCollection;
  class ResourceMonitorCollection;
  class RunMonitorCollection;
  class StreamsMonitorCollection;


  class SMWebPageHelper : public WebPageHelper<SMWebPageHelper>
  {
  public:

    SMWebPageHelper
    (
      xdaq::ApplicationDescriptor*,
      SharedResourcesPtr
    );

    void defaultWebPage(xgi::Output*) const;

    void inputWebPage(xgi::Output*) const;

    void storedDataWebPage(xgi::Output*) const;

    void filesWebPage(xgi::Output*) const;

    void consumerStatistics(xgi::Output*) const;

    void resourceBrokerOverview(xgi::Output*) const;

    void resourceBrokerDetail(xgi::Output*, const long long& uniqueRBID) const;

    void dqmEventWebPage(xgi::Output*) const;

    void throughputWebPage(xgi::Output*) const;
        
    
  private:

    XHTMLMaker::Node* createWebPageBody
    (
      XHTMLMaker&,
      const std::string& pageTitle,
      const StateMachineMonitorCollection&
    ) const;
    
    void addDOMforHyperLinks(XHTMLMaker&, XHTMLMaker::Node* parent) const;

    void addDOMforSummaryInformation
    (
      XHTMLMaker&,
      XHTMLMaker::Node* parent,
      DataSenderMonitorCollection const&,
      StreamsMonitorCollection const&,
      EventConsumerMonitorCollection const&,
      DQMEventMonitorCollection const&,
      RegistrationCollectionPtr
    ) const;

    void addDOMforResourceUsage
    (
      XHTMLMaker&,
      XHTMLMaker::Node* parent,
      ResourceMonitorCollection const&,
      ThroughputMonitorCollection const&
    ) const;

    void addDOMforFragmentMonitor
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      FragmentMonitorCollection const&
    ) const;

    void addDOMforRunMonitor
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      RunMonitorCollection const&
    ) const;

    void addDOMforStoredData
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      StreamsMonitorCollection const&
    ) const;

    void addDOMforConfigString
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      DiskWritingParams const&
    ) const;

    void addDOMforFiles
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      FilesMonitorCollection const&
    ) const;

    void addDOMforThroughputStatistics
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      ThroughputMonitorCollection const&
    ) const;
    
    double getServedConsumerBandwidth
    (
      const std::string& label,
      RegistrationCollectionPtr,
      const EventConsumerMonitorCollection& eventConsumerCollection
    ) const;
    
    void addRowForThroughputStatistics
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      const ThroughputMonitorCollection::Stats::Snapshot&,
      bool const isAverage = false
    ) const;

    void listStreamRecordsStats
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      StreamsMonitorCollection const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addFragmentStats
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;
    
    void addRowForFramesReceived
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addRowForBandwidth
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addRowForRate
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addRowForLatency
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addRowForTotalVolume
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addRowForMaxBandwidth
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addRowForMinBandwidth
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      FragmentMonitorCollection::FragmentStats const&,
      const MonitoredQuantity::DataSetType
    ) const;

    void addOutputModuleTables
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      DataSenderMonitorCollection const&
    ) const;

    void addOutputModuleStatistics
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      long long uniqueRBID,
      DataSenderMonitorCollection const&
    ) const;

    void addOutputModuleStatistics
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      DataSenderMonitorCollection::OutputModuleResultsList const&
    ) const;

    void addOutputModuleSummary
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      DataSenderMonitorCollection::OutputModuleResultsList const&
    ) const;

    void addResourceBrokerList
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      DataSenderMonitorCollection const&
    ) const;

    void addResourceBrokerDetails
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      long long uniqueRBID,
      DataSenderMonitorCollection const&
    ) const;

    void addFilterUnitList
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      long long uniqueRBID,
      DataSenderMonitorCollection const&
    ) const;

    void addTableForResourceUsages
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      ThroughputMonitorCollection::Stats const&,
      ResourceMonitorCollection::Stats const&
    ) const;

    void addRowsForThroughputUsage
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      ThroughputMonitorCollection::Stats const&
    ) const;

    void addRowsForWorkers
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      ResourceMonitorCollection::Stats const&
    ) const;

    void addRowsForSataBeast
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* table,
      ResourceMonitorCollection::Stats const&
    ) const;

    void addTableForDiskUsages
    (
      XHTMLMaker& maker,
      XHTMLMaker::Node* parent,
      ResourceMonitorCollection::Stats const&
    ) const;


  private:

    //Prevent copying of the SMWebPageHelper
    SMWebPageHelper(SMWebPageHelper const&);
    SMWebPageHelper& operator=(SMWebPageHelper const&);

    SharedResourcesPtr sharedResources_;

    typedef ConsumerWebPageHelper<SMWebPageHelper,
                                  EventQueueCollection,
                                  StatisticsReporter> ConsumerWebPageHelper_t;
    ConsumerWebPageHelper_t consumerWebPageHelper_;

  };

} // namespace stor

#endif // EventFilter_StorageManager_SMWebPageHelper_h