PeriodicThread.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_THREAD_PERIODIC_THREAD_H_INCLUDED
#define ICL_CORE_THREAD_PERIODIC_THREAD_H_INCLUDED

#include <icl_core/BaseTypes.h>
#include <icl_core/Noncopyable.h>
#include <icl_core/TimeSpan.h>
#include <icl_core/os_thread.h>

#include "icl_core_thread/ImportExport.h"
#include "icl_core_thread/Thread.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {
namespace thread {

class PeriodicThreadImpl;

class ICL_CORE_THREAD_IMPORT_EXPORT PeriodicThread : public Thread,
                                                     protected virtual icl_core::Noncopyable
{
public:
  PeriodicThread(const icl_core::String& description, const icl_core::TimeSpan& period,
                 ThreadPriority priority = 0);

  virtual ~PeriodicThread();

  icl_core::TimeSpan period() const;

  bool setPeriod(const icl_core::TimeSpan& period);

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE icl_core::TimeSpan Period() const
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool SetPeriod(const icl_core::TimeSpan& period)
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

protected:
  void waitPeriod();

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE void WaitPeriod() ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  virtual void makePeriodic();

  PeriodicThreadImpl *m_impl;
};

}
}

#endif