source.h

Go to the documentation of this file.

/*
 *  source.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 SOURCE_H
#define SOURCE_H
 
// C++ include
#include <cassert>
 
// Includes from nestkernel:
#include "nest_types.h"
 
namespace nest
{
 
class Source
{
private:
  size_t node_id_ : NUM_BITS_NODE_ID;  
  bool processed_ : 1;                 
  bool primary_ : 1;                   
  bool disabled_ : 1;                  
 
public:
  Source();
  explicit Source( const size_t node_id, const bool primary );
 
  size_t get_node_id() const;
 
  void set_processed( const bool processed );
  bool is_processed() const;
 
  void set_primary( const bool primary );
 
  bool is_primary() const;
 
  void disable();
 
  bool is_disabled() const;
 
  friend bool operator<( const Source& lhs, const Source& rhs );
  friend bool operator>( const Source& lhs, const Source& rhs );
  friend bool operator==( const Source& lhs, const Source& rhs );
};
 
inline Source::Source()
  : node_id_( 0 )
  , processed_( false )
  , primary_( true )
  , disabled_( false )
{
}
 
inline Source::Source( const size_t node_id, const bool is_primary )
  : node_id_( node_id )
  , processed_( false )
  , primary_( is_primary )
  , disabled_( false )
{
  assert( node_id <= MAX_NODE_ID );
}
 
inline size_t
Source::get_node_id() const
{
  return node_id_;
}
 
inline void
Source::set_processed( const bool processed )
{
  processed_ = processed;
}
 
inline bool
Source::is_processed() const
{
  return processed_;
}
 
inline void
Source::set_primary( const bool primary )
{
  primary_ = primary;
}
 
inline bool
Source::is_primary() const
{
  return primary_;
}
 
inline void
Source::disable()
{
  disabled_ = true;
}
 
inline bool
Source::is_disabled() const
{
  return disabled_;
}
 
inline bool
operator<( const Source& lhs, const Source& rhs )
{
  return ( lhs.node_id_ < rhs.node_id_ );
}
 
inline bool
operator>( const Source& lhs, const Source& rhs )
{
  return operator<( rhs, lhs );
}
 
inline bool
operator==( const Source& lhs, const Source& rhs )
{
  return ( lhs.node_id_ == rhs.node_id_ );
}
 
}  // namespace nest
 
#endif /* #ifndef SOURCE_H */