ware/ObserverSignature.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID 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 3 of the License, or
  (at your option) any later version.

  OpenFLUID 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 OpenFLUID. If not, see <http://www.gnu.org/licenses/>.


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/


/**
  \file ObserverSignature.hpp
  \brief Header of ...

  \author Jean-Christophe FABRE <fabrejc@supagro.inra.fr>
 */


#ifndef __OBSERVERSIGNATURE_HPP__
#define __OBSERVERSIGNATURE_HPP__

#include <openfluid/config.hpp>
#include <openfluid/dllexport.hpp>
#include <openfluid/core/TypeDefs.hpp>
#include <openfluid/ware/WareSignature.hpp>


// =====================================================================
// =====================================================================

/**
  Macro for the beginning of definition of observer hook
*/
#define BEGIN_OBSERVER_SIGNATURE(id) \
  openfluid::ware::ObserverSignature* WARESIGNATURE_PROC_DECL() \
  { \
    openfluid::ware::ObserverSignature* Signature = new openfluid::ware::ObserverSignature(); \
    Signature->setABIVersion(openfluid::config::FULL_VERSION); \
    Signature->ID = (id);


/**
  Macro for the end of definition of signature hook
*/
#define END_OBSERVER_SIGNATURE \
    return Signature; \
  }


// =====================================================================
// =====================================================================


namespace openfluid { namespace ware {

class DLLEXPORT ObserverSignature : public WareSignature
{

  public:

    ObserverSignature() : WareSignature()
      {}

};


} }  // namespaces


#endif /* __OBSERVERSIGNATURE_HPP__ */