-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * Config_ValidatorMessage.h
- *
- * Created on: 08 Jul 2014 �.
- * Author: sbh
- */
+// Copyright (C) 2014-2024 CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library 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
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
#ifndef CONFIG_VALIDATORMESSAGE_H_
#define CONFIG_VALIDATORMESSAGE_H_
#include <string>
/// Event ID that Validator is loaded (comes with Config_ValidatorMessage)
-static const char * EVENT_VALIDATOR_LOADED = "ValidatorLoaded";
+MAYBE_UNUSED static const char * EVENT_VALIDATOR_LOADED = "ValidatorLoaded";
/*!
* \class Config_ValidatorMessage
+ * \ingroup Config
* \brief Transmits info about created validator on "ValidatorLoaded" event
*/
class Config_ValidatorMessage : public Events_Message
std::list<std::string> myVaidatorParameters;
public:
+ /*!
+ * Constructor.
+ * \param theId - Events_ID of the message
+ * \param theParent - pointer to the sender
+ */
CONFIG_EXPORT Config_ValidatorMessage(const Events_ID theId, const void* theParent = 0);
CONFIG_EXPORT virtual ~Config_ValidatorMessage();
- //CONFIG_EXPORT static const char* UID() const;
-
+ //! Get id of the filter
CONFIG_EXPORT const std::string& validatorId() const;
+ //! Get id of a feature to which the filter belongs to
CONFIG_EXPORT const std::string& featureId() const;
+ //! Get id of an attribute to which the filter belongs to
CONFIG_EXPORT const std::string& attributeId() const;
+ //! Get filter parameters
CONFIG_EXPORT const std::list<std::string>& parameters() const;
+ //! Returns true if validator id is not empty
CONFIG_EXPORT bool isValid() const;
+ //! Set id of the filter
CONFIG_EXPORT void setValidatorId(const std::string& theId);
+ //! Set id of a feature to which the filter belongs to
CONFIG_EXPORT void setFeatureId(const std::string& theId);
+ //! Set id of an attribute to which the filter belongs to
CONFIG_EXPORT void setAttributeId(const std::string& theId);
+ //! Get filter parameters
CONFIG_EXPORT void setValidatorParameters(const std::list<std::string>& parameters);
};