Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
ScXMLEventTarget.h
1 #ifndef SCXML_EVENTTARGET_H
2 #define SCXML_EVENTTARGET_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/scxml/ScXMLObject.h>
37 #include <Inventor/tools/SbPimplPtr.h>
38 
39 class ScXMLSendElt;
40 class ScXMLEventElt;
41 class ScXMLEvent;
42 
43 class COIN_DLL_API ScXMLEventTarget : public ScXMLObject {
44  typedef ScXMLObject inherited;
45  SCXML_OBJECT_ABSTRACT_HEADER(ScXMLEventTarget)
46 
47 public:
48  static void initClass(void);
49  static void cleanClass(void);
50 
51  ScXMLEventTarget(void);
52  virtual ~ScXMLEventTarget(void);
53 
54  // event-target identification
55  virtual void setEventTargetType(const char * targettype);
56  const char * getEventTargetType(void) const { return this->targettype; }
57 
58  virtual void setEventTargetName(const char * targetname);
59  const char * getEventTargetName(void) const { return this->targetname; }
60 
61  // event processing
62  virtual const ScXMLEvent * getCurrentEvent(void) const { return this->currentevent; }
63 
64  virtual void queueEvent(const ScXMLEvent * event);
65  virtual void queueEvent(const SbName & eventid);
66 
67  virtual SbBool processEventQueue(void);
68 
69  // inter-system communication
70  virtual SbBool sendExternalEvent(const ScXMLSendElt * sendelt);
71  virtual SbBool sendInternalEvent(const ScXMLEventElt * sendelt);
72 
73  virtual void queueInternalEvent(const ScXMLEvent * event);
74  virtual void queueInternalEvent(const SbName & eventid);
75 
76 protected:
77  char * targetname;
78  char * targettype;
79 
80  const ScXMLEvent * currentevent;
81  SbBool isprocessingqueue;
82 
83  virtual void setCurrentEvent(const ScXMLEvent * event);
84  virtual const ScXMLEvent * getNextEvent(void);
85  virtual const ScXMLEvent * getNextInternalEvent(void);
86  virtual const ScXMLEvent * getNextExternalEvent(void);
87 
88  virtual SbBool processOneEvent(const ScXMLEvent * event);
89 
90  static void registerEventTarget(ScXMLEventTarget * target, const char * sessionid = NULL);
91  static void unregisterEventTarget(ScXMLEventTarget * target, const char * sessionid = NULL);
92 
93  static ScXMLEventTarget * getEventTarget(const char * targettype, const char * targetname, const char * sessionid = NULL);
94 
95 private:
96  ScXMLEventTarget(const ScXMLEventTarget & rhs); // N/A
97  ScXMLEventTarget & operator = (const ScXMLEventTarget & rhs); // N/A
98 
99  class PImpl;
100  SbPimplPtr<PImpl> pimpl;
101 
102 }; // ScXMLEventTarget
103 
104 #endif // !SCXML_EVENTTARGET_H
the < send> SCXML element.
Definition: ScXMLSendElt.h:43
Base class for events sent to SCXML state machines.
Definition: ScXMLEvent.h:40
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition: ScXMLObject.cpp:102
static void cleanClass(void)
Does the opposite of initClass, deallocates any class specific resources and resets the class to an u...
Definition: ScXMLObject.cpp:115
Base class for all SCXML objects.
Definition: ScXMLObject.h:41
base class for event targets for inter-system event communication
Definition: ScXMLEventTarget.h:43
The SbName class stores strings by reference.
Definition: SbName.h:40
virtual const ScXMLEvent * getCurrentEvent(void) const
Definition: ScXMLEventTarget.h:62
implements the <event> SCXML element.
Definition: ScXMLEventElt.h:43