device.h

Go to the documentation of this file.

/*
 *  device.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 DEVICE_H
#define DEVICE_H
 
 
// Includes from nestkernel:
#include "nest_time.h"
#include "nest_types.h"
#include "node.h"
 
 
namespace nest
{
 
class Device
{
public:
  Device();
  Device( const Device& n );
  virtual ~Device()
  {
  }
 
  virtual void
  init_state()
  {
  }
 
  virtual void
  init_buffers()
  {
  }
 
  virtual void pre_run_hook();
 
  virtual void get_status( Dictionary& ) const;
  virtual void set_status( const Dictionary& );
 
  virtual bool is_active( Time const& T ) const = 0;
 
  long get_t_min_() const;
 
  long get_t_max_() const;
 
  Time const& get_origin() const;
  Time const& get_start() const;
  Time const& get_stop() const;
 
private:
  // ----------------------------------------------------------------
 
  struct Parameters_
  {
    Time origin_;
 
    Time start_;
 
    Time stop_;
 
    Parameters_();  
 
    Parameters_( const Parameters_& );
 
    Parameters_& operator=( const Parameters_& );
 
    void get( Dictionary& ) const;  
    void set( const Dictionary& );  
 
  private:
    static void update_( const Dictionary&, const std::string&, Time& );
  };
 
 
  // ----------------------------------------------------------------
 
  struct Variables_
  {
 
    long t_min_;
 
    long t_max_;
  };
 
  // ----------------------------------------------------------------
 
  Parameters_ P_;
  Variables_ V_;
};
 
inline void
Device::get_status( Dictionary& d ) const
{
  P_.get( d );
}
 
inline void
Device::set_status( const Dictionary& d )
{
  Parameters_ ptmp = P_;  // temporary copy in case of errors
  ptmp.set( d );          // throws if BadProperty
 
  // if we get here, temporaries contain consistent set of properties
  P_ = ptmp;
}
 
inline Time const&
Device::get_origin() const
{
  return P_.origin_;
}
 
inline Time const&
Device::get_start() const
{
  return P_.start_;
}
 
inline Time const&
Device::get_stop() const
{
  return P_.stop_;
}
 
inline long
Device::get_t_min_() const
{
  return V_.t_min_;
}
 
inline long
Device::get_t_max_() const
{
  return V_.t_max_;
}
 
}  // namespace nest
 
#endif /* DEVICE_H */