delay_checker.h

Go to the documentation of this file.

/*
 *  delay_checker.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef DELAY_CHECKER_H
#define DELAY_CHECKER_H
 
// Includes from nestkernel:
#include "nest_time.h"
 
#include "dictionary.h"
 
 
namespace nest
{
class TimeConverter;
 
class DelayChecker
{
public:
  DelayChecker();
  DelayChecker( const DelayChecker& cr );
 
  const Time& get_min_delay() const;
 
  const Time& get_max_delay() const;
 
  void freeze_delay_update();
 
  void enable_delay_update();
 
  void assert_valid_delay_ms( double );
 
  void assert_two_valid_delays_steps( long, long );
 
  bool get_user_set_delay_extrema() const;
 
  void calibrate( const TimeConverter& tc );
 
  void get_status( Dictionary& d ) const;
  void set_status( const Dictionary& d );
 
private:
  Time min_delay_;               
  Time max_delay_;               
  bool user_set_delay_extrema_;  
  bool freeze_delay_update_;
 
  void set_min_max_delay_( const double, const double );
};
 
inline const Time&
DelayChecker::get_min_delay() const
{
  return min_delay_;
}
 
inline const Time&
DelayChecker::get_max_delay() const
{
  return max_delay_;
}
 
inline bool
DelayChecker::get_user_set_delay_extrema() const
{
  return user_set_delay_extrema_;
}
 
inline void
DelayChecker::freeze_delay_update()
{
  freeze_delay_update_ = true;
}
 
inline void
DelayChecker::enable_delay_update()
{
  freeze_delay_update_ = false;
}
}
 
 
#endif /* DELAY_CHECKER_H */