X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModel%2FModel_Events.h;h=ac36a99611800b1ed24947455aa0912353c44d1e;hb=50a8df0c6a66da8067b16155e5ae39f8f26a7ebc;hp=0bce1c980bc508eed36659bb9a3504a12d50e8c0;hpb=afaf6f0d254de478da37f984674a71e296cb3404;p=modules%2Fshaper.git diff --git a/src/Model/Model_Events.h b/src/Model/Model_Events.h index 0bce1c980..ac36a9961 100644 --- a/src/Model/Model_Events.h +++ b/src/Model/Model_Events.h @@ -1,109 +1,122 @@ -// File: Model_Events.h -// Created: 10 Apr 2014 -// Author: Mikhail PONIKAROV - -#ifndef Model_Events_HeaderFile -#define Model_Events_HeaderFile +// Copyright (C) 2014-2020 CEA/DEN, EDF R&D +// +// 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 Model_Events_H_ +#define Model_Events_H_ #include -#include -#include -#include -#include -#include - -class ModelAPI_Feature; -class ModelAPI_Document; - -/// Event ID that feature is created (comes with Model_FeatureUpdatedMessage) -static const char * EVENT_FEATURE_CREATED = "FeatureCreated"; -/// Event ID that data of feature is updated (comes with Model_FeatureUpdatedMessage) -static const char * EVENT_FEATURE_UPDATED = "FeatureUpdated"; -/// Event ID that data of feature is deleted (comes with Model_FeatureDeletedMessage) -static const char * EVENT_FEATURE_DELETED = "FeatureDeleted"; -/// Event ID that data of feature is updated (comes with Model_FeaturesMovedMessage) -static const char * EVENT_FEATURE_MOVED = "FeaturesMoved"; +#include + +#include + +/// Allows to create ModelAPI messages +class Model_EventCreator : public ModelAPI_EventCreator +{ + public: + /// creates created, updated or moved messages and sends to the loop + virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent, + const bool isGroupped = true) const; + + /// creates created, updated or moved messages with the objects collection and sends to the loop + virtual void sendUpdated(const std::list& theObjects, const Events_ID& theEvent, + const bool isGroupped = true) const; + /// creates deleted message and sends to the loop + virtual void sendDeleted(const std::shared_ptr& theDoc, + const std::string& theGroup) const; + + /// creates reordered message and sends to the loop + virtual void sendReordered(const std::shared_ptr& theReordered) const; + + /// must be one per application, the constructor for internal usage only + Model_EventCreator(); +}; /// Message that feature was changed (used for Object Browser update): moved, updated and deleted -class Model_FeatureUpdatedMessage : public Events_MessageGroup { - std::set > myFeatures; ///< which feature is changed -public: - /// sender is not important, all information is located in the feature - Model_FeatureUpdatedMessage( - const boost::shared_ptr& theFeature, - const Events_ID& theEvent) : Events_MessageGroup(theEvent, 0) - {if (theFeature) myFeatures.insert(theFeature);} - - /// Returns the feature that has been updated - std::set > features() const {return myFeatures;} - - //! Creates a new empty group (to store it in the loop before flush) - virtual Events_MessageGroup* newEmpty() { - boost::shared_ptr anEmptyFeature; - return new Model_FeatureUpdatedMessage(anEmptyFeature, eventID()); - } - - //! Allows to join the given message with the current one - virtual void Join(Events_MessageGroup& theJoined) { - Model_FeatureUpdatedMessage* aJoined = dynamic_cast(&theJoined); - std::set >::iterator aFIter = aJoined->myFeatures.begin(); - for(; aFIter != aJoined->myFeatures.end(); aFIter++) { - myFeatures.insert(*aFIter); - } - } -}; +class Model_ObjectUpdatedMessage : public ModelAPI_ObjectUpdatedMessage +{ + std::set myObjects; ///< which feature is changed -/// Message that feature was deleted (used for Object Browser update) -class Model_FeatureDeletedMessage : public Events_MessageGroup { - boost::shared_ptr myDoc; ///< document owner of the feature - std::set myGroups; ///< group identifiers that contained the deleted feature -public: - /// creates a message by initialization of fields -// Model_FeatureDeletedMessage(const boost::shared_ptr& theDoc, -// const std::string& theGroup); + /// Sender is not important, all information is located in the feature. + /// Use ModelAPI for creation of this event. Used for creation, movement and edition events. + Model_ObjectUpdatedMessage(const ObjectPtr& theObject, const Events_ID& theEvent); - /// Returns the ID of this message (EVENT_FEATURE_DELETED) -// static const Events_ID messageId(); + friend class Model_EventCreator; + public: /// Returns the feature that has been updated - boost::shared_ptr document() const {return myDoc;} - - /// Returns the group where the feature was deleted - const std::set& groups() const {return myGroups;} + virtual const std::set& objects() const; //! Creates a new empty group (to store it in the loop before flush) -// virtual Events_MessageGroup* newEmpty(); + virtual std::shared_ptr newEmpty(); //! Allows to join the given message with the current one -// virtual void Join(Events_MessageGroup& theJoined); + virtual void Join(const std::shared_ptr& theJoined); +}; - Events_MessageGroup* newEmpty() { - return new Model_FeatureDeletedMessage(myDoc, ""); +/// Message that feature was deleted (used for Object Browser update) +class Model_ObjectDeletedMessage : public ModelAPI_ObjectDeletedMessage +{ + ///< group identifiers that contained the deleted feature and document where they are deleted + std::list, std::string> > myGroups; + + /// Use ModelAPI for creation of this event. + Model_ObjectDeletedMessage(const std::shared_ptr& theDoc, + const std::string& theGroup); + + friend class Model_EventCreator; + public: + /// Returns the group where the objects were deleted + virtual const std::list, std::string> >& + groups() const + { + return myGroups; } - Model_FeatureDeletedMessage( - const boost::shared_ptr& theDoc, const std::string& theGroup) - : Events_MessageGroup(messageId(), 0), myDoc(theDoc) + /// Returns the new empty message of this type + virtual std::shared_ptr newEmpty(); - { - if (!theGroup.empty()) - myGroups.insert(theGroup); - } + /// Returns the identifier of this message + virtual const Events_ID messageId(); - const Events_ID messageId() - { - static Events_ID MY_ID = Events_Loop::eventByName(EVENT_FEATURE_DELETED); - return MY_ID; - } + /// Appends to this message the given one + virtual void Join(const std::shared_ptr& theJoined); +}; - void Join(Events_MessageGroup& theJoined) +/// Message that feature was deleted (used for Object Browser update) +class Model_OrderUpdatedMessage : public ModelAPI_OrderUpdatedMessage +{ + std::shared_ptr myReordered; ///< the feature that was moved + + /// Use ModelAPI for creation of this event. + Model_OrderUpdatedMessage(FeaturePtr theReordered, + const void* theSender = 0); + + friend class Model_EventCreator; + public: + /// Returns the document that has been updated + virtual std::shared_ptr reordered() { - Model_FeatureDeletedMessage* aJoined = dynamic_cast(&theJoined); - std::set::iterator aGIter = aJoined->myGroups.begin(); - for(; aGIter != aJoined->myGroups.end(); aGIter++) { - myGroups.insert(*aGIter); - } + return myReordered; } + + /// Returns the identifier of this message + virtual const Events_ID messageId(); }; #endif