X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_AttributeMessage.h;h=e9ab250ea633cbeddab9e34fc07f74f3bac6da1a;hb=3f1a42a51c7de1911c75453ff7134593d7d2c6b1;hp=9272a7b6ed3fd9f82d535d5a9fc2770f3f79e02f;hpb=331af9b7eb4feddf17c37fe2ce1f0f046f522145;p=modules%2Fshaper.git diff --git a/src/Config/Config_AttributeMessage.h b/src/Config/Config_AttributeMessage.h index 9272a7b6e..e9ab250ea 100644 --- a/src/Config/Config_AttributeMessage.h +++ b/src/Config/Config_AttributeMessage.h @@ -18,32 +18,52 @@ */ 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