Coin: ScXMLTransitionElt.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

ScXMLTransitionElt.h
1#ifndef COIN_SCXMLTRANSITIONELT_H
2#define COIN_SCXMLTRANSITIONELT_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/ScXMLElt.h>
37#include <Inventor/tools/SbPimplPtr.h>
38
39class ScXMLEvent;
40class ScXMLExecutableElt;
41class ScXMLStateMachine;
42
43 class COIN_DLL_API ScXMLTransitionElt : public ScXMLElt {
44 typedef ScXMLElt inherited;
45 SCXML_ELEMENT_HEADER(ScXMLTransitionElt)
46public:
47 static void initClass(void);
48 static void cleanClass(void);
49
50 ScXMLTransitionElt(void);
51 virtual ~ScXMLTransitionElt(void);
52
53 // XML attributes
54 virtual void setEventAttribute(const char * event);
55 const char * getEventAttribute(void) const { return this->event; }
56
57 virtual void setCondAttribute(const char * cond);
58 const char * getCondAttribute(void) const { return this->cond; }
59
60 virtual void setTargetAttribute(const char * target);
61 const char * getTargetAttribute(void) const { return this->target; }
62
63 virtual void setAnchorAttribute(const char * anchor);
64 const char * getAnchorAttribute(void) const { return this->anchor; }
65
66 virtual SbBool handleXMLAttributes(void);
67
68 virtual void copyContents(const ScXMLElt * rhs);
69
70 virtual const ScXMLElt * search(const char * attrname, const char * attrvalue) const;
71
72 // predicates
73 SbBool isConditionLess(void) const;
74 SbBool isTargetLess(void) const;
75 SbBool isSelfReferencing(void) const;
76
77 // check
78 virtual SbBool isEventMatch(const ScXMLEvent * event) const;
79 // isConditionMatch() ?
80 virtual SbBool evaluateCondition(ScXMLStateMachine * statemachine);
81
82 // executable content
83 virtual int getNumExecutables(void) const;
84 virtual ScXMLExecutableElt * getExecutable(int idx) const;
85 virtual void addExecutable(ScXMLExecutableElt * executable);
86 virtual void removeExecutable(ScXMLExecutableElt * executable);
87 virtual void clearAllExecutables(void);
88
89 virtual void execute(ScXMLStateMachine * statemachine) const;
90
91protected:
92 char * event;
93 char * cond;
94 char * target;
95 char * anchor;
96
97 SbBool needprefixmatching;
98 SbName eventkey;
99 SbName targetkey;
100
101private:
102 ScXMLTransitionElt(const ScXMLTransitionElt & rhs); // N/A
103 ScXMLTransitionElt & operator = (const ScXMLTransitionElt & rhs); // N/A
104
105 class PImpl;
106 SbPimplPtr<PImpl> pimpl;
107
108}; // ScXMLTransitionElt
109
110#endif // !COIN_SCXMLTRANSITIONELT_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SbPimplPtr
Definition SbPimplPtr.h:55
ScXMLElt
base class for all SCXML elements.
Definition ScXMLElt.h:44
ScXMLElt::search
virtual const ScXMLElt * search(const char *attrname, const char *attrvalue) const
Definition ScXMLElt.cpp:214
ScXMLElt::handleXMLAttributes
virtual SbBool handleXMLAttributes(void)
Definition ScXMLElt.cpp:200
ScXMLEvent
Base class for events sent to SCXML state machines.
Definition ScXMLEvent.h:40
ScXMLExecutableElt
base class for all SCXML elements with executable content.
Definition ScXMLExecutableElt.h:42
ScXMLStateMachine
Manager for processing events and setting states in SCXML structures.
Definition ScXMLStateMachine.h:61
ScXMLTransitionElt
the <transition> SCXML element.
Definition ScXMLTransitionElt.h:43