stop_watch.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 stop_watch

#ifndef STOP_WATCH_H
#define STOP_WATCH_H

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

#ifndef STD_CTIME_H
#include "SheafSystem/std_ctime.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

#ifndef STD_VECTOR_H
#include "SheafSystem/std_vector.h"
#endif

namespace sheaf
{
  
class SHEAF_DLL_SPEC stop_watch
{

public:

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

  // Default memberwise assignment operator

  virtual bool invariant() const;
  

  // ===========================================================
  // STOP_WATCH FACET
  // ===========================================================

  stop_watch();

  // Default memberwise copy constructor

  virtual ~stop_watch();

  enum time_unit
  {
    CPU_TIME,
    MILLISECONDS,
    SECONDS
  };

  void start();

  void stop();

  double time(time_unit xunit = SECONDS) const;

  double cumulative_time() const;

  void mark_lap();

  double lap_time(int i) const;

  size_t lap_ct() const;

  void reset();


private:

  clock_t _start_time;

  clock_t _stop_time;

  double _cumulative_time;

  std::vector<double> _lap_times;

};

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

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

#endif // ifndef STOP_WATCH_H