Salome HOME
Corrections in the documentation of the Config package
[modules/shaper.git] / src / Config / Config_ValidatorMessage.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 /*
4  * Config_ValidatorMessage.h
5  *
6  *  Created on: 08 Jul 2014 �.
7  *      Author: sbh
8  */
9
10 #ifndef CONFIG_VALIDATORMESSAGE_H_
11 #define CONFIG_VALIDATORMESSAGE_H_
12
13 #include <Events_Message.h>
14 #include <Config_def.h>
15
16 #include <list>
17 #include <string>
18
19 /// Event ID that Validator is loaded (comes with Config_ValidatorMessage)
20 static const char * EVENT_VALIDATOR_LOADED = "ValidatorLoaded";
21
22 /*!
23  * \class Config_ValidatorMessage
24  * \brief Transmits info about created validator on "ValidatorLoaded" event
25  */
26 class Config_ValidatorMessage : public Events_Message
27 {
28   std::string myValidatorId;
29   std::string myFeatureId;
30   std::string myAttributeId;
31   std::list<std::string> myVaidatorParameters;
32
33  public:
34   CONFIG_EXPORT Config_ValidatorMessage(const Events_ID theId, const void* theParent = 0);
35   CONFIG_EXPORT virtual ~Config_ValidatorMessage();
36
37   //CONFIG_EXPORT static const char* UID() const;
38
39   CONFIG_EXPORT const std::string& validatorId() const;
40   CONFIG_EXPORT const std::string& featureId() const;
41   CONFIG_EXPORT const std::string& attributeId() const;
42   CONFIG_EXPORT const std::list<std::string>& parameters() const;
43   CONFIG_EXPORT bool isValid() const;
44
45   CONFIG_EXPORT void setValidatorId(const std::string& theId);
46   CONFIG_EXPORT void setFeatureId(const std::string& theId);
47   CONFIG_EXPORT void setAttributeId(const std::string& theId);
48   CONFIG_EXPORT void setValidatorParameters(const std::list<std::string>& parameters);
49 };
50
51 #endif /* Config_ValidatorMessage_H_ */