/**
 * Copyright Verimag laboratory.
 * 
 * contributors:
 *  Jacques Combaz (jacques.combaz@univ-grenoble-alpes.fr)
 * 
 * This software is a computer program whose purpose is to generate
 * executable code from BIP models.
 * 
 * This software is governed by the CeCILL-B license under French law and
 * abiding by the rules of distribution of free software.  You can  use, 
 * modify and/ or redistribute the software under the terms of the CeCILL-B
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 * 
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or 
 * data to be ensured and,  more generally, to use and operate it in the 
 * same conditions as regards security.
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */

#ifndef _BIP_Engine_AtomExternalPortItf_HPP_
#define _BIP_Engine_AtomExternalPortItf_HPP_

#include <bip-engineiface-config.hpp>
using namespace bipbasetypes;
using namespace biptypes;

// referenced classes
class Atom;
class PortValue;


class AtomExternalPortItf {
 public:
  // destructor
  virtual ~AtomExternalPortItf();

  // operations
  virtual void notify() = 0;
  virtual void initialize() = 0;
  virtual bool hasEvent() const = 0;
  virtual void popEvent() = 0;
  virtual void purgeEvents() = 0;

  // getters for attributes
  const string &name() const { return mName; }
  const EventConsumptionPolicy &policy() const { return mPolicy; }
  const bool &waiting() const { return mWaiting; }

  // setters for attributes
  void setWaiting(const bool &waiting) { mWaiting = waiting; }

  // opposites accessors
  Atom &holder() const { return *mHolder; }
  bool hasHolder() const { return mHolder != NULL; }
  void setHolder(Atom &atom) { mHolder = &atom; }

 protected:
  // protected constructors
  AtomExternalPortItf(const string &name, const EventConsumptionPolicy &policy);

  // attributes
  const string mName;
  const EventConsumptionPolicy mPolicy;
  bool mWaiting;

  // opposites
  Atom *mHolder;
};

#endif // _BIP_Engine_AtomExternalPortItf_HPP_
