Result CompSolid should inherits ResultBody. All model realization concerned Naming...

[modules/shaper.git] / src / Config / Config_AttributeMessage.h

diff --git a/src/Config/Config_AttributeMessage.h b/src/Config/Config_AttributeMessage.h
index f8ac8e3d5d325b83e347051f4cf1adda163e1034..e9ab250ea633cbeddab9e34fc07f74f3bac6da1a 100644 (file)
--- a/src/Config/Config_AttributeMessage.h
+++ b/src/Config/Config_AttributeMessage.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 #ifndef ATTRIBUTE_MESSAGE_H
 #define ATTRIBUTE_MESSAGE_H
 
@@ -7,38 +9,61 @@
 
 #include <string>
 
-/*
- * Class to pass an attribute's (widget's) entry info extracted from xml file.
+/*!
+ * \class Config_AttributeMessage
+ * \brief Class to pass an attribute's (widget's) entry info extracted from xml file.
+ * \code
  * <widget id="tool_object" concealment="true" obligatory="0"/>
+ * \endcode
  */
 class Config_AttributeMessage : public Events_Message
 {
-  std::string myAttributeId;  //Feature unique id
-  std::string myFeatureId;  //Feature unique id
-  bool myIsObligatory;
-  bool myIsConcealment;
+  std::string myAttributeId; ///< Attribute's unique id
+  std::string myFeatureId; ///< Attribute's feature's unique id
+  bool myIsObligatory; ///< Required to be set by user, else it's feature is invalid.
+  bool myIsConcealment; ///< If true, conceals features used as input
+  std::string myCaseId; ///< Attribute's case's id, if it placed inside a paged containers
+  std::string mySwitchId; ///< Attribute's switch id, if it placed inside a paged containers
 
  public:
-  // Same event as Config_FeatureMessage::MODEL_EVENT()
+  /// Same event as Config_FeatureMessage::MODEL_EVENT()
   inline static const char* MODEL_EVENT()
   {
     return Config_FeatureMessage::MODEL_EVENT();
   }
 
-  //const Events_ID theID, const void* theSender = 0
+  /// Constructor
   CONFIG_EXPORT Config_AttributeMessage(const Events_ID theId, const void* theParent = 0);
+  /// Destructor
   CONFIG_EXPORT virtual ~Config_AttributeMessage();
 
   //Auto-generated getters/setters
+  /// Returns attribute's unique id
   CONFIG_EXPORT const std::string& attributeId() const;
+  /// Returns attribute's feature's unique id
   CONFIG_EXPORT const std::string& featureId() const;
+  /// Returns true if attribute is obligatory:
+  /// Required to be set by user, else it's feature is invalid.
   CONFIG_EXPORT bool isObligatory() const;
+  /// Returns true if attribute should conceal input features
   CONFIG_EXPORT bool isConcealment() const;
+  /// Returns id of a case which contain the attribute
+  CONFIG_EXPORT const std::string& caseId() const;
+  /// Returns id of a switch which contain the attribute
+  CONFIG_EXPORT const std::string& switchId() const;
 
+  /// Set attribute's unique id
   CONFIG_EXPORT void setAttributeId(const std::string& theId);
+  /// Set attribute's feature's unique id
   CONFIG_EXPORT void setFeatureId(const std::string& id);
+  /// Set attribute's concealment state
   CONFIG_EXPORT void setConcealment(bool isConcealment);
+  /// Set attribute's obligatory state
   CONFIG_EXPORT void setObligatory(bool isObligatory);
+  /// Set attribute's case
+  CONFIG_EXPORT void setCaseId(const std::string& id);
+  /// Set attribute's switch
+  CONFIG_EXPORT void setSwitchId(const std::string& id);
 };
 
 #endif // ATTRIBUTE_MESSAGE_H