report.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class report

#ifndef REPORT_H
#define REPORT_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

#ifndef STOP_WATCH_H
#include "SheafSystem/stop_watch.h"
#endif

#ifndef STD_STRING_H
#include "SheafSystem/std_string.h"
#endif

namespace sheaf
{
  
class namespace_poset;

class SHEAF_DLL_SPEC report
{

public:

  // ===========================================================
  // ANY FACET
  // ===========================================================

  virtual bool invariant() const;

  // ===========================================================
  // REPORT FACET
  // ===========================================================

  report();  

  report(const namespace_poset* xname_space);

  virtual ~report();

  void start(const std::string& xname);

  void reset();

  void point(const std::string& xname);

  void write(const std::string& xfile_name) const;  

  inline const namespace_poset* name_space() const
  {
    return _name_space;
  };

  inline std::string title() const
  {
    return _title;
  };

  inline stop_watch watch() const
  {
    return _watch;
  };
  
  inline block<std::string> names() const
  {
    return _names;
  };

  inline block<size_t> memory() const
  {
    return _memory;
  }
  
  inline block<size_t> memory_part(int lpart) const
  {
    return _memory_parts[lpart];
  }

private:

  const namespace_poset* _name_space;

  std::string _title;

  stop_watch _watch;

  block<std::string> _names;

  block<size_t> _memory;

  block<size_t> _memory_parts[4];

};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================

SHEAF_DLL_SPEC
std::ostream & operator << (std::ostream &os, report& xreport);
 
} // namespace sheaf

#endif // ifndef STOP_WATCH_H