base/FuncSignature.hpp

Go to the documentation of this file.

/*
  This file is part of OpenFLUID software
  Copyright (c) 2007-2010 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/>.

  In addition, as a special exception, INRA gives You the additional right
  to dynamically link the code of OpenFLUID with code not covered
  under the GNU General Public License ("Non-GPL Code") and to distribute
  linked combinations including the two, subject to the limitations in this
  paragraph. Non-GPL Code permitted under this exception must only link to
  the code of OpenFLUID dynamically through the OpenFLUID libraries
  interfaces, and only for building OpenFLUID plugins. The files of
  Non-GPL Code may be link to the OpenFLUID libraries without causing the
  resulting work to be covered by the GNU General Public License. You must
  obey the GNU General Public License in all respects for all of the
  OpenFLUID code and other code used in conjunction with OpenFLUID
  except the Non-GPL Code covered by this exception. If you modify
  this OpenFLUID, you may extend this exception to your version of the file,
  but you are not obligated to do so. If you do not wish to provide this
  exception without modification, you must delete this exception statement
  from your version and license this OpenFLUID solely under the GPL without
  exception.


 == 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.
*/


#ifndef __FUNCSIGNATURE_H__
#define __FUNCSIGNATURE_H__



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

#define BEGIN_SIGNATURE_HOOK \
  openfluid::base::FunctionSignature* GetPlugSignature() \
  { \
    openfluid::base::FunctionSignature* Signature = new openfluid::base::FunctionSignature(); \
    Signature->setSDKVersion(STRINGIFY(OPENFLUID_VERSION));


#define END_SIGNATURE_HOOK \
    return Signature; \
  }


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


#define DECLARE_SIGNATURE_ID(id) Signature->ID = id;

#define DECLARE_SIGNATURE_NAME(name) Signature->Name = name;

#define DECLARE_SIGNATURE_DESCRIPTION(desc) Signature->Description = desc;

#define DECLARE_SIGNATURE_DOMAIN(domain) Signature->Domain = domain;

#define DECLARE_SIGNATURE_PROCESS(process) Signature->Process = process;

#define DECLARE_SIGNATURE_METHOD(method) Signature->Method = method;

#define DECLARE_SIGNATURE_AUTHORNAME(name) Signature->Author = name;

#define DECLARE_SIGNATURE_AUTHOREMAIL(email) Signature->AuthorEmail = email;

#define DECLARE_SIGNATURE_VERSION(version) Signature->Version = version;

#define DECLARE_SIGNATURE_STATUS(status) Signature->Status = status;

#define DECLARE_SIGNATURE_SDKVERSION Signature->setSDKVersion(STRINGIFY(OPENFLUID_VERSION));

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


#define DECLARE_FUNCTION_PARAM(name,description,unit) \
  Signature->HandledData.FunctionParams.push_back(openfluid::base::SignatureHandledDataItem((name),(""),description,unit));



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


#define DECLARE_PRODUCED_VAR(name,uclass,description,unit) \
  Signature->HandledData.ProducedVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

#define DECLARE_UPDATED_VAR(name,uclass,description,unit) \
  Signature->HandledData.UpdatedVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

#define DECLARE_REQUIRED_VAR(name,uclass,description,unit) \
  Signature->HandledData.RequiredVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));



#define DECLARE_REQUIRED_PREVVAR(name,uclass,description,unit) \
  Signature->HandledData.RequiredPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

#define DECLARE_USED_VAR(name,uclass,description,unit) \
  Signature->HandledData.UsedVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));


#define DECLARE_USED_PREVVAR(name,uclass,description,unit) \
  Signature->HandledData.UsedPrevVars.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

#define DECLARE_REQUIRED_INPUTDATA(name,uclass,description,unit) \
  Signature->HandledData.RequiredInput.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

#define DECLARE_USED_INPUTDATA(name,uclass,description,unit) \
  Signature->HandledData.UsedInput.push_back(openfluid::base::SignatureHandledDataItem((name),uclass,description,unit));

#define DECLARE_USED_EVENTS(uclass) Signature->HandledData.UsedEventsOnUnits.push_back(uclass);



#define DECLARE_UPDATED_UNITSGRAPH(description) Signature->HandledUnitsGraph.UpdatedUnitsGraph = (description);


#define DECLARE_UPDATED_UNITSCLASS(uclass,description) Signature->HandledUnitsGraph.UpdatedUnitsClass.push_back(openfluid::base::SignatureHandledUnitsClassItem(uclass,description));


#define DECLARE_REQUIRED_EXTRAFILE(name) \
  Signature->HandledData.RequiredExtraFiles.push_back(name);

#define DECLARE_USED_EXTRAFILE(name) \
  Signature->HandledData.UsedExtraFiles.push_back(name);


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



namespace openfluid { namespace base {


typedef std::string FuncID_t;
typedef std::string FuncName_t;
typedef std::string FuncVersion_t;
typedef std::string FuncMethod_t;
typedef std::string FuncProcess_t;
typedef std::string FuncDomain_t;


enum FuncStatus_t
{
  EXPERIMENTAL,

  BETA,

  STABLE
};


// =====================================================================
// =====================================================================
struct SignatureHandledDataItem
{
  std::string DataName;
  openfluid::core::UnitClass_t UnitClass;
  std::string Description;
  std::string DataUnit;

  SignatureHandledDataItem()
  {
    DataName = "";
    UnitClass = "";
    Description = "";
    DataUnit = "";
  }

  SignatureHandledDataItem(std::string DName, openfluid::core::UnitClass_t UClass,
                           std::string DDescription, std::string DUnit)
  {
    DataName = DName;
    UnitClass = UClass;
    Description = DDescription;
    DataUnit = DUnit;
  }

};


struct SignatureHandledUnitsClassItem
{
  openfluid::core::UnitClass_t UnitsClass;
  std::string Description;

  SignatureHandledUnitsClassItem()
  {
    UnitsClass = "";
    Description = "";
  }

  SignatureHandledUnitsClassItem(openfluid::core::UnitClass_t UClass,
                           std::string DDescription)
  {
    UnitsClass = UClass;
    Description = DDescription;
  }

};


struct SignatureHandledData
{
  std::vector<SignatureHandledDataItem> ProducedVars;

  std::vector<SignatureHandledDataItem> UpdatedVars;

  std::vector<SignatureHandledDataItem> RequiredVars;

  std::vector<SignatureHandledDataItem> UsedVars;

  std::vector<SignatureHandledDataItem> RequiredPrevVars;

  std::vector<SignatureHandledDataItem> UsedPrevVars;

  std::vector<SignatureHandledDataItem> FunctionParams;

  std::vector<SignatureHandledDataItem> RequiredInput;

  std::vector<SignatureHandledDataItem> UsedInput;

  std::vector<std::string> RequiredExtraFiles;

  std::vector<std::string> UsedExtraFiles;

  std::vector<openfluid::core::UnitClass_t> UsedEventsOnUnits;


  SignatureHandledData()
  {

  }

};


struct SignatureHandledUnitsGraph
{
    std::string UpdatedUnitsGraph;

    std::vector<SignatureHandledUnitsClassItem> UpdatedUnitsClass;

    SignatureHandledUnitsGraph()
    {
      UpdatedUnitsGraph.clear();
    }
};



struct FunctionSignature
{

  FuncID_t ID;

  FuncName_t Name;

  std::string Description;

  FuncDomain_t Domain;

  FuncProcess_t Process;

  FuncMethod_t Method;

  FuncVersion_t Version;

  FuncStatus_t Status;

  std::string SDKVersion;

  std::string Author;

  std::string AuthorEmail;

  SignatureHandledData HandledData;

  SignatureHandledUnitsGraph HandledUnitsGraph;


  FunctionSignature()
  {
    ID = "";
    Name = "";
    Description = "";
    Domain = "";
    Process = "";
    Method = "";
    Author = "";
    AuthorEmail = "";
    Version = "";
    Status = EXPERIMENTAL;
    SDKVersion = "";
  }

  void setSDKVersion(FuncVersion_t Version)
  {
    SDKVersion = Version;
  }

};



} } // namespaces



#endif