Issue #1860: fix end lines with spaces

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

diff --git a/src/Config/Config_AttributeMessage.h b/src/Config/Config_AttributeMessage.h
index 9272a7b6ed3fd9f82d535d5a9fc2770f3f79e02f..d2a8cf705b44f625ffc292317cfd5c130d0625de 100644 (file)
--- a/src/Config/Config_AttributeMessage.h
+++ b/src/Config/Config_AttributeMessage.h
@@ -8,6 +8,7 @@
 #include <Events_Message.h>
 
 #include <string>
+#include <list>
 
 /*!
  * \class Config_AttributeMessage
@@ -18,31 +19,47 @@
  */
 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
+  ///< a list of pairs, if the attribute is placed inside paged containers: (case, switch)
+  std::list<std::pair<std::string, std::string> > myCases;
 
- public:
-  // Same event as Config_FeatureMessage::MODEL_EVENT()
+public:
+  /// 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 container of ids of pair of a case and switches
+  CONFIG_EXPORT const std::list<std::pair<std::string, std::string> >& getCases() const;
+  /// Sets ids of pair of a case and switches
+  CONFIG_EXPORT void setCases(const std::list<std::pair<std::string, std::string> >& theCases);
 
+  /// 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);
 };