Event.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 Event.hpp

  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
*/


#ifndef __OPENFLUID_CORE_EVENT_HPP__
#define __OPENFLUID_CORE_EVENT_HPP__


#include <openfluid/dllexport.hpp>
#include <openfluid/core/TypeDefs.hpp>
#include <openfluid/core/DateTime.hpp>


namespace openfluid { namespace core {


/**
  Class defining  a discrete event, including attached information

  Each event attached information is represented by a Key-Value couple :
  @li Key is the name given to the information
  @li Value is the value of the information and can be numeric or text information

  @cond OpenFLUID:completion
  {
    "contexts" : ["ANYWARE"],
    "menupath" : ["Compute code", "Types", "Events"],
    "title" : "Event",
    "text" : "openfluid::core::Event %%SEL_START%%Ev%%SEL_END%%"
  }
  @endcond
*/
class OPENFLUID_API Event
{
  public:

    typedef std::map<std::string, openfluid::core::StringValue> EventInfosMap_t;


  private:

    DateTime m_Date;

    EventInfosMap_t m_Infos;


  public:

    /**
      Default constructor
    */
    Event();

    /**
      Constructor
      @param[in] Date the date and time of the event
    */
    Event(const DateTime& Date);

    /**
      Destructor
    */
    ~Event();

    /**
      Returns true if the information exists
      @param[in] Key the requested information key
    */
    bool isInfoExist(const std::string& Key) const;

    /**
      Returns true if the information exists and equals the given string value
      @param[in] Key the requested information key
      @param[in] Value the requested value
    */
    bool isInfoEqual(const std::string& Key, const std::string& Value) const;

    /**
      Returns true if the information exists and equals the given long value
      @param[in] Key the requested information key
      @param[in] Value the requested value
    */
    bool isInfoEqual(const std::string& Key, long Value) const;

    /**
      Returns true if the information exists and equals the given double value
      @param[in] Key the requested information key
      @param[in] Value the requested value
    */
    bool isInfoEqual(const std::string& Key, const double Value) const;

    /**
      Returns true if the information exists and equals the given double value
      @param[in] Key the requested information key
      @param[in] Info the requested value
      @deprecated Since version 1.7.1. Use openfluid::core::Event::isInfoEqual(const std::string&,const double) const
    */
    [[deprecated]] bool isInfoEqual(const std::string& Key, const double* Info) const;

    /**
      Returns true if the information exists and equals the given DoubleValue value
      @param[in] Key the requested information key
      @param[in] Info the requested value
    */
    bool isInfoEqual(const std::string& Key, const DoubleValue& Info) const;

    /**
      Returns the number of information
    */
    inline int getInfosCount() const
    {
      return m_Infos.size();
    }

    /**
      Returns all the informations as an EventInfosMap
    */
    inline EventInfosMap_t getInfos() const
    {
      return m_Infos;
    }

    /**
      Returns the date and time of the event
    */
    inline DateTime getDateTime() const
    {
      return m_Date;
    }

    /**
      Gets an information as a string
      @param[in] Key the requested information key
      @param[out] Info the value corresponding to the requested key
      @return true if the key exists and the conversion to the requested type is correct
      @deprecated Since version 1.7.1.
      Use openfluid::core::Event::getInfoAsString(const std::string&,std::string&) const instead
    */
    [[deprecated]] bool getInfoAsString(const std::string& Key, std::string *Info) const;

    /**
      Gets an information as a string
      @param[in] Key the requested information key
      @param[out] Info the value corresponding to the requested key
      @return true if the key exists and the conversion to the requested type is correct
    */
    bool getInfoAsString(const std::string& Key, std::string& Info) const;

    /**
      Gets an information as a long integer
      @param[in] Key the requested information key
      @param[out] Info the value corresponding to the requested key
      @return true if the key exists and the conversion to the requested type is correct
      @deprecated Since version 1.7.1. Use openfluid::core::Event::getInfoAsLong(const std::string&,long&) const instead
    */
    [[deprecated]] bool getInfoAsLong(const std::string& Key, long *Info) const;

    /**
      Gets an information as a long integer
      @param[in] Key the requested information key
      @param[out] Info the value corresponding to the requested key
      @return true if the key exists and the conversion to the requested type is correct
    */
    bool getInfoAsLong(const std::string& Key, long& Info) const;

    /**
      Gets an information as a double
      @param[in] Key the requested information key
      @param[out] Info the value corresponding to the requested key
      @return true if the key exists and the conversion to the requested type is correct
      @deprecated Since version 1.7.1.
      Use openfluid::core::Event::getInfoAsDouble(const std::string&,double&) const instead
    */
    [[deprecated]] bool getInfoAsDouble(const std::string& Key, double *Info) const;

    /**
      Gets an information as a double
      @param[in] Key the requested information key
      @param[out] Info the value corresponding to the requested key
      @return true if the key exists and the conversion to the requested type is correct
    */
    bool getInfoAsDouble(const std::string& Key, double& Info) const;

    /**
      Gets an information as a DoubleValue
      @param[in] Key the requested information key
      @param[out] Info the value corresponding to the requested key
      @return true if the key exists and the conversion to the requested type is correct
    */
    bool getInfoAsDoubleValue(const std::string& Key, DoubleValue& Info) const;

    /**
      Adds an information to the event
      @param[in] Key the key of the added information
      @param[in] Info the value of the added information
      @return true if the adding is correct (key does not already exists)
    */
    bool addInfo(const std::string& Key, const std::string& Info);

    /**
      Prints the content of the event to stdout
    */
    void println() const;

};

} } // namespace openfluid::core

#endif /* __OPENFLUID_CORE_EVENT_HPP__ */