Salome HOME
f424d421437025642b8766c8f37e16085effc3c5
[modules/shaper.git] / src / ModelAPI / ModelAPI_Events.h
1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef MODELAPI_EVENTS_H_
21 #define MODELAPI_EVENTS_H_
22
23 #include <ModelAPI.h>
24 #include <ModelAPI_Object.h>
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_Attribute.h>
27 #include <Events_MessageGroup.h>
28 #include <Events_Loop.h>
29
30 #include <memory>
31 #include <string>
32 #include <set>
33 #include <map>
34
35
36 class ModelAPI_Document;
37 class ModelAPI_ResultParameter;
38 class GeomAPI_Pnt2d;
39
40 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
41 static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
42 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
43 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
44 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
45 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
46 /// Event ID that name of feature is changed (comes with Model_ObjectRenamedMessage)
47 static const char * EVENT_OBJECT_RENAMED = "ObjectRenamed";
48 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
49 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
50 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
51 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
52 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
53 static const char * EVENT_PLUGIN_LOADED = "PluginLoaded";
54 /// The active document becomes another one
55 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
56
57 /// Event ID that order of objects in group is changed,
58 /// so, tree must be fully recreated (movement of feature)
59 static const char * EVENT_ORDER_UPDATED = "OrderUpdated";
60 /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed
61 static const char * EVENT_UPDATE_SELECTION = "UpdateSelection";
62
63 /// Request for the enabled/disabled actions behavior for some specific features
64 static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
65 /// Reply for the enabled/disabled actions behavior for some specific features
66 static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
67
68 /// To block the viewer updates
69 static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
70 /// To unblock the viewer updates
71 static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
72
73 /// To inform that there is an empty presentation in the viewer
74 static const char * EVENT_EMPTY_AIS_PRESENTATION = "EmptyAISPresentation";
75 /// To inform that there is an empty operation for presentation in the viewer
76 static const char * EVENT_EMPTY_OPERATION_PRESENTATION = "EmptyOperationPresentation";
77 /// To block preview
78 static const char * EVENT_PREVIEW_BLOCKED = "PreviewBlocked";
79 /// To preview the current feature in the viewer (to compute the result)
80 static const char * EVENT_PREVIEW_REQUESTED = "PreviewRequested";
81 /// To block automatic recomputation of any feature (by the GUI button press)
82 static const char * EVENT_AUTOMATIC_RECOMPUTATION_DISABLE = "DisableAutomaticRecomputation";
83 /// To unblock block automatic recomputation (default state: the GUI button unpressed)
84 static const char * EVENT_AUTOMATIC_RECOMPUTATION_ENABLE = "EnableAutomaticRecomputation";
85
86 /// Event ID that solver has conflicting constraints (comes with ModelAPI_SolverFailedMessage)
87 static const char * EVENT_SOLVER_FAILED = "SolverFailed";
88 /// Event ID that the problem in solver disappeared
89 static const char * EVENT_SOLVER_REPAIRED = "SolverRepaired";
90
91 /// Event Id that sketch has DoF = 0
92 static const char * EVENT_SKETCH_FULLY_CONSTRAINED = "SketchFullyConstrainted";
93 /// Event Id that sketch has DoF > 0
94 static const char * EVENT_SKETCH_UNDER_CONSTRAINED = "SketchUnderConstrainted";
95 /// Event Id that sketch has DoF < 0
96 static const char * EVENT_SKETCH_OVER_CONSTRAINED  = "SketchOverConstrainted";
97
98 /// Event ID that informs that some object has changed the stability
99 static const char * EVENT_STABILITY_CHANGED = "StabilityChanged";
100
101 /// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed
102 static const char * EVENT_SKETCH_PREPARED = "SketchPrepared";
103
104 /// Event ID that provides a request for list of non-fixed objects necessary for DoF = 0
105 static const char * EVENT_GET_DOF_OBJECTS = "GetDoFObjects";
106
107 /// Event ID that provides a request for list of non-fixed objects necessary for DoF = 0
108 static const char * EVENT_DOF_OBJECTS = "DoFObjects";
109
110 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
111 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
112 {
113  protected:
114   /// Creates an empty message
115   ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
116   /// The virtual destructor
117   virtual ~ModelAPI_ObjectUpdatedMessage();
118
119  public:
120   /// Returns the feature that has been updated
121   virtual const std::set<ObjectPtr>& objects() const = 0;
122
123   //! Creates a new empty group (to store it in the loop before flush)
124   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
125
126   //! Allows to join the given message with the current one
127   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
128 };
129
130 /// Message that feature was deleted (used for Object Browser update)
131 class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
132 {
133 protected:
134   /// Creates an empty message
135   ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
136   /// The virtual destructor
137   virtual ~ModelAPI_ObjectDeletedMessage();
138
139 public:
140   /// Returns the groups where the objects were deleted
141   virtual const std::list<std::pair<std::shared_ptr<ModelAPI_Document>, std::string> >&
142     groups() const = 0;
143
144   /// Creates the new empty message of this kind
145   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
146
147   /// Returns the identifier of the kind of a message
148   virtual const Events_ID messageId() = 0;
149
150   /// Appends to this message the given one.
151   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
152 };
153
154 /// Message that order changed (used for Object Browser update)
155 class MODELAPI_EXPORT ModelAPI_OrderUpdatedMessage : public Events_Message
156 {
157 protected:
158   /// Creates a message:
159   ModelAPI_OrderUpdatedMessage(const Events_ID theID, const void* theSender = 0);
160   /// The virtual destructor
161   virtual ~ModelAPI_OrderUpdatedMessage();
162
163 public:
164   /// Returns the document that has been updated
165   virtual std::shared_ptr<ModelAPI_Feature> reordered() = 0;
166
167   /// Returns the identifier of the kind of a message
168   virtual const Events_ID messageId() = 0;
169 };
170
171 /// Allows to create ModelAPI messages
172 class MODELAPI_EXPORT ModelAPI_EventCreator
173 {
174 public:
175   /// creates created, updated or moved messages and sends to the loop
176   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
177                            const bool isGroupped = true) const = 0;
178   /// creates created, updated or moved messages with the objects collection and sends to the loop
179   virtual void sendUpdated(const std::list<ObjectPtr>& theObjects, const Events_ID& theEvent,
180     const bool isGroupped = true) const = 0;
181   /// creates deleted message and sends to the loop
182   virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
183                            const std::string& theGroup) const = 0;
184   /// creates reordered message and sends to the loop
185   virtual void sendReordered(const std::shared_ptr<ModelAPI_Feature>& theReordered) const = 0;
186
187   /// returns the creator instance
188   static const ModelAPI_EventCreator* get();
189
190   /// sets the creator instance
191   static void set(const ModelAPI_EventCreator* theCreator);
192 };
193
194 /// Contains the state information about the feature: is it enabled or disabled.
195 class ModelAPI_FeatureStateMessage : public Events_Message
196 {
197 public:
198   /// Creates an empty message
199   MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
200   /// The virtual destructor
201   MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
202
203   /// Returns the feature this message is related to
204   MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
205   /// Stores the feature this message is related to
206   MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
207   // For response
208   /// Returns true if feature has specific state
209   MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
210   /// Returns true if feature is enabled
211   MODELAPI_EXPORT bool state(const  std::string& theFeatureId, bool theDefault = false) const;
212   /// Stores the feature state
213   MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
214   /// Returns all feature IDs with states
215   MODELAPI_EXPORT std::list<std::string> features() const;
216
217  private:
218   /// For Request
219   std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
220   /// For response
221   std::map<std::string, bool> myFeatureState;
222 };
223
224 /// Message that document (Part, PartSet) was created
225 class ModelAPI_DocumentCreatedMessage : public Events_Message
226 {
227   DocumentPtr myDocument;
228
229  public:
230   /// Creates an empty message
231   MODELAPI_EXPORT ModelAPI_DocumentCreatedMessage(const Events_ID theID, const void* theSender = 0);
232   /// The virtual destructor
233   MODELAPI_EXPORT virtual ~ModelAPI_DocumentCreatedMessage();
234   /// Static. Returns EventID of the message.
235   MODELAPI_EXPORT static Events_ID eventId()
236   {
237     static const char * MY_DOCUMENT_CREATED_EVENT_ID("DocumentCreated");
238     return Events_Loop::eventByName(MY_DOCUMENT_CREATED_EVENT_ID);
239   }
240
241   /// Returns a document stored in the message
242   MODELAPI_EXPORT DocumentPtr document() const;
243   /// Sets a document to the message
244   MODELAPI_EXPORT void setDocument(DocumentPtr theDocument);
245 };
246
247 /// Message that attribute text should be evaluated in the attribute value
248 class ModelAPI_AttributeEvalMessage : public Events_Message
249 {
250   AttributePtr myAttribute;
251
252  public:
253   /// Static. Returns EventID of the message.
254   MODELAPI_EXPORT static Events_ID& eventId()
255   {
256     static const char * MY_ATTRIBUTE_EVALUATION_EVENT_ID("AttributeEvaluationRequest");
257     static Events_ID anId = Events_Loop::eventByName(MY_ATTRIBUTE_EVALUATION_EVENT_ID);
258     return anId;
259   }
260
261   /// Useful method that creates and sends the AttributeEvalMessage event
262   MODELAPI_EXPORT static void send(AttributePtr theAttribute, const void* theSender)
263   {
264     std::shared_ptr<ModelAPI_AttributeEvalMessage> aMessage =
265       std::shared_ptr<ModelAPI_AttributeEvalMessage>(
266       new ModelAPI_AttributeEvalMessage(eventId(), theSender));
267     aMessage->setAttribute(theAttribute);
268     Events_Loop::loop()->send(aMessage);
269   }
270
271   /// Creates an empty message
272   MODELAPI_EXPORT ModelAPI_AttributeEvalMessage(const Events_ID theID, const void* theSender = 0);
273   /// The virtual destructor
274   MODELAPI_EXPORT virtual ~ModelAPI_AttributeEvalMessage();
275
276   /// Returns a document stored in the message
277   MODELAPI_EXPORT AttributePtr attribute() const;
278   /// Sets an attribute to the message
279   MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute);
280 };
281
282 /// Message that parameter feature expression should be evaluated: value and error producing
283 class ModelAPI_ParameterEvalMessage : public Events_Message
284 {
285   FeaturePtr myParam; ///< parameters that should be evaluated
286   bool myIsProcessed; ///< true if results were set
287   /// result of processing, list of parameters in expression found
288   std::list<std::shared_ptr<ModelAPI_ResultParameter> > myParamsList;
289   double myResult; ///< result of processing, the computed value of the expression
290   std::string myError; ///< error of processing, empty if there is no error
291
292  public:
293   /// Static. Returns EventID of the message.
294   MODELAPI_EXPORT static Events_ID& eventId()
295   {
296     static const char * MY_PARAMETER_EVALUATION_EVENT_ID("ParameterEvaluationRequest");
297     static Events_ID anId = Events_Loop::eventByName(MY_PARAMETER_EVALUATION_EVENT_ID);
298     return anId;
299   }
300
301   /// Useful method that creates and sends the event.
302   /// Returns the message, processed, with the resulting fields filled.
303   MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ParameterEvalMessage>
304     send(FeaturePtr theParameter, const void* theSender)
305   {
306     std::shared_ptr<ModelAPI_ParameterEvalMessage> aMessage =
307       std::shared_ptr<ModelAPI_ParameterEvalMessage>(
308       new ModelAPI_ParameterEvalMessage(eventId(), theSender));
309     aMessage->setParameter(theParameter);
310     Events_Loop::loop()->send(aMessage);
311     return aMessage;
312   }
313
314   /// Creates an empty message
315   MODELAPI_EXPORT ModelAPI_ParameterEvalMessage(const Events_ID theID, const void* theSender = 0);
316   /// The virtual destructor
317   MODELAPI_EXPORT virtual ~ModelAPI_ParameterEvalMessage();
318
319   /// Returns a parameter stored in the message
320   MODELAPI_EXPORT FeaturePtr parameter() const;
321   /// Sets a parameter to the message
322   MODELAPI_EXPORT void setParameter(FeaturePtr theParam);
323   /// Sets the results of processing
324   MODELAPI_EXPORT void setResults(
325     const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& theParamsList,
326     const double theResult, const std::string& theError);
327   /// Returns true if the expression is processed
328   MODELAPI_EXPORT bool isProcessed();
329   /// Returns the results of processing: list of parameters found in the expression
330   MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_ResultParameter> >& params() const;
331   /// Returns the expression result
332   MODELAPI_EXPORT const double& result() const;
333   /// Returns the interpreter error (empty if no error)
334   MODELAPI_EXPORT const std::string& error() const;
335 };
336
337
338 /// Message to ask compute the positions of parameters in the expression
339 class ModelAPI_ComputePositionsMessage : public Events_Message
340 {
341   std::string myExpression; ///< the expression string
342   std::string myParamName; ///< name of the parameter to be searched
343   std::list<std::pair<int, int> > myPositions; ///< computation result: start-end position indices
344
345 public:
346   /// Static. Returns EventID of the message.
347   MODELAPI_EXPORT static Events_ID& eventId()
348   {
349     static const char * MY_COMPUTE_POSITIOND_EVENT_ID("ComputePositionsRequest");
350     static Events_ID anId = Events_Loop::eventByName(MY_COMPUTE_POSITIOND_EVENT_ID);
351     return anId;
352   }
353
354   /// Useful method that creates and sends the AttributeEvalMessage event
355   /// Returns the message, processed, with the resulting fields filled
356   MODELAPI_EXPORT static std::shared_ptr<ModelAPI_ComputePositionsMessage>
357     send(const std::string& theExpression, const std::string& theParameter, const void* theSender)
358   {
359     std::shared_ptr<ModelAPI_ComputePositionsMessage> aMessage =
360       std::shared_ptr<ModelAPI_ComputePositionsMessage>(
361       new ModelAPI_ComputePositionsMessage(eventId(), theSender));
362     aMessage->set(theExpression, theParameter);
363     Events_Loop::loop()->send(aMessage);
364     return aMessage;
365   }
366
367   /// Creates an empty message
368   MODELAPI_EXPORT ModelAPI_ComputePositionsMessage(
369     const Events_ID theID, const void* theSender = 0);
370   /// The virtual destructor
371   MODELAPI_EXPORT virtual ~ModelAPI_ComputePositionsMessage();
372
373   /// Returns an expression stored in the message
374   MODELAPI_EXPORT const std::string& expression() const;
375   /// Returns a parameter name stored in the message
376   MODELAPI_EXPORT const std::string& parameter() const;
377   /// Sets an expression and parameter needed for computation
378   MODELAPI_EXPORT void set(const std::string& theExpression, const std::string& theParameter);
379   /// Sets the results of processing
380   MODELAPI_EXPORT void setPositions(const std::list<std::pair<int, int> >& thePositions);
381   /// Returns the results of processing: position start and end indices
382   MODELAPI_EXPORT const std::list<std::pair<int, int> >& positions() const;
383 };
384
385 /// Message that the object is renamed
386 class ModelAPI_ObjectRenamedMessage : public Events_Message
387 {
388   ObjectPtr myObject;
389   std::string myOldName;
390   std::string myNewName;
391
392  public:
393   /// Static. Returns EventID of the message.
394   MODELAPI_EXPORT static Events_ID& eventId()
395   {
396     static const char * MY_OBJECT_RENAMED_EVENT_ID("ObjectRenamed");
397     static Events_ID anId = Events_Loop::eventByName(MY_OBJECT_RENAMED_EVENT_ID);
398     return anId;
399   }
400
401   /// Useful method that creates and sends the AttributeEvalMessage event
402   MODELAPI_EXPORT static void send(ObjectPtr theObject,
403                                    const std::string& theOldName,
404                                    const std::string& theNewName,
405                                    const void* theSender);
406
407   /// Creates an empty message
408   MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage(const Events_ID theID, const void* theSender = 0);
409   /// The virtual destructor
410   MODELAPI_EXPORT virtual ~ModelAPI_ObjectRenamedMessage();
411
412   /// Returns an object
413   MODELAPI_EXPORT ObjectPtr object() const;
414   /// Sets an object
415   MODELAPI_EXPORT void setObject(ObjectPtr theObject);
416   /// Returns an old name
417   MODELAPI_EXPORT std::string oldName() const;
418   /// Sets an old name
419   MODELAPI_EXPORT void setOldName(const std::string& theOldName);
420   /// Returns a new name
421   MODELAPI_EXPORT std::string newName() const;
422   /// Sets a new name
423   MODELAPI_EXPORT void setNewName(const std::string& theNewName);
424 };
425
426 /// Message that the parameter should be replaced with its value
427 class ModelAPI_ReplaceParameterMessage : public Events_Message
428 {
429   ObjectPtr myObject;
430
431  public:
432   /// Static. Returns EventID of the message.
433   MODELAPI_EXPORT static Events_ID& eventId()
434   {
435     static const char * MY_EVENT_ID("ReplaceParameter");
436     static Events_ID anId = Events_Loop::eventByName(MY_EVENT_ID);
437     return anId;
438   }
439
440   /// Useful method that creates and sends the AttributeEvalMessage event
441   MODELAPI_EXPORT static void send(ObjectPtr theObject,
442                                    const void* theSender);
443
444   /// Creates an empty message
445   MODELAPI_EXPORT
446     ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
447   /// The virtual destructor
448   MODELAPI_EXPORT virtual ~ModelAPI_ReplaceParameterMessage();
449
450   /// Returns an object
451   MODELAPI_EXPORT ObjectPtr object() const;
452   /// Sets an object
453   MODELAPI_EXPORT void setObject(ObjectPtr theObject);
454 };
455
456 /// Message that sends the sketch solver and sketcher GUI processes to show in the property panel
457 class ModelAPI_SolverFailedMessage : public Events_Message
458 {
459 public:
460   /// Creates an message
461   MODELAPI_EXPORT ModelAPI_SolverFailedMessage(const Events_ID theID, const void* theSender = 0);
462   /// Default destructor
463   MODELAPI_EXPORT virtual ~ModelAPI_SolverFailedMessage();
464
465   /// Sets list of conflicting constraints
466   MODELAPI_EXPORT void setObjects(const std::set<ObjectPtr>& theObjects);
467   /// Returns list of conflicting constraints
468   MODELAPI_EXPORT const std::set<ObjectPtr>& objects() const;
469
470   /// Sets degrees of freedom
471   void dof(const int theDOF) { myDOF = theDOF; }
472   /// Returns degrees of freedom
473   const int& dof() const { return myDOF; }
474
475 private:
476   std::set<ObjectPtr> myObjects;
477   int myDOF;
478 };
479
480 /// Message sent when feature or attribute has been moved.
481 /// Stores the moving object/attribute, original and new positions of mouse.
482 class ModelAPI_ObjectMovedMessage : public Events_Message
483 {
484   ObjectPtr myMovedObject;
485   AttributePtr myMovedAttribute;
486
487   std::shared_ptr<GeomAPI_Pnt2d> myOriginalPosition;
488   std::shared_ptr<GeomAPI_Pnt2d> myCurrentPosition;
489
490 public:
491   MODELAPI_EXPORT ModelAPI_ObjectMovedMessage(const void* theSender = 0);
492
493   /// Set object which is being moved (if the message already contains attribute it will be cleared)
494   MODELAPI_EXPORT void setMovedObject(const ObjectPtr& theMovedObject);
495   /// Set attribute which is being moved (if the message already contains object it will be cleared)
496   MODELAPI_EXPORT void setMovedAttribute(const AttributePtr& theMovedAttribute);
497
498   /// Return moved object
499   ObjectPtr movedObject() const
500   { return myMovedObject; }
501   /// Return moved attribute
502   AttributePtr movedAttribute() const
503   { return myMovedAttribute; }
504
505   /// Set original mouse position
506   MODELAPI_EXPORT void setOriginalPosition(double theX, double theY);
507   /// Set original mouse position
508   MODELAPI_EXPORT void setOriginalPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
509   /// Return original mouse position
510   const std::shared_ptr<GeomAPI_Pnt2d>& originalPosition() const
511   { return myOriginalPosition; }
512
513   /// Set current mouse position
514   MODELAPI_EXPORT void setCurrentPosition(double theX, double theY);
515   /// Set current mouse position
516   MODELAPI_EXPORT void setCurrentPosition(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
517   /// Return current mouse position
518   const std::shared_ptr<GeomAPI_Pnt2d>& currentPosition() const
519   { return myCurrentPosition; }
520 };
521
522 #endif