src/Config/Config_SelectionFilterMessage.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * Config_SelectionFilterMessage.h
   5  *
   6  *  Created on: 08 Jul 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef CONFIG_SELECTIONFILTERMESSAGE_H_
  11 #define CONFIG_SELECTIONFILTERMESSAGE_H_
  12
  13 #include <Events_Message.h>
  14 #include <Config_def.h>
  15
  16 #include <list>
  17 #include <string>
  18
  19 /// Event ID that Selection Filter is loaded (comes with Config_SelectionFilterMessage)
  20 static const char * EVENT_SELFILTER_LOADED = "SelectionFilterLoaded";
  21
  22 /*!
  23  * \class Config_SelectionFilterMessage
  24  * \ingroup Config
  25  * \brief Transmits info about selection filters on "SelectionFilterLoaded" event
  26  */
  27 class Config_SelectionFilterMessage : public Events_Message
  28 {
  29   std::string mySelectionFilterId;
  30   std::string myFeatureId;
  31   std::string myAttributeId;
  32   std::list<std::string> myFilterParameters;
  33
  34  public:
  35   /*!
  36    * Constructor.
  37    * \param theId - Events_ID of the message
  38    * \param theParent - pointer to the sender
  39    */
  40   CONFIG_EXPORT Config_SelectionFilterMessage(const Events_ID theId, const void* theParent = 0);
  41   CONFIG_EXPORT virtual ~Config_SelectionFilterMessage();
  42
  43   //! Get id of the filter
  44   CONFIG_EXPORT const std::string& selectionFilterId() const;
  45   //! Get id of a feature to which the filter belongs to
  46   CONFIG_EXPORT const std::string& featureId() const;
  47   //! Get id of an attribute to which the filter belongs to
  48   CONFIG_EXPORT const std::string& attributeId() const;
  49   //! Get filter parameters
  50   CONFIG_EXPORT const std::list<std::string>& parameters() const;
  51
  52   //! Set id of the filter
  53   CONFIG_EXPORT void setSelectionFilterId(const std::string& theId);
  54   //! Set id of a feature to which the filter belongs to
  55   CONFIG_EXPORT void setFeatureId(const std::string& theId);
  56   //! Set id of an attribute to which the filter belongs to
  57   CONFIG_EXPORT void setAttributeId(const std::string& theId);
  58   //! Get filter parameters
  59   CONFIG_EXPORT void setFilterParameters(const std::list<std::string>& parameters);
  60 };
  61
  62 #endif /* CONFIG_SELECTIONFILTERMESSAGE_H_ */