Coin: ScXMLSendElt.h Source File

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

ScXMLSendElt.h
1#ifndef COIN_SCXMLSENDELT_H
2#define COIN_SCXMLSENDELT_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/ScXMLExecutableElt.h>
37
38#include <Inventor/tools/SbLazyPimplPtr.h>
39
40class ScXMLEvent;
41class ScXMLEventTarget;
42
43 class COIN_DLL_API ScXMLSendElt : public ScXMLExecutableElt {
44 typedef ScXMLExecutableElt inherited;
45 SCXML_ELEMENT_HEADER(ScXMLSendElt)
46
47public:
48 static void initClass(void);
49 static void cleanClass(void);
50
51 ScXMLSendElt(void);
52 virtual ~ScXMLSendElt(void);
53
54 virtual void setEventAttribute(const char * event);
55 virtual const char * getEventAttribute(void) const { return this->event; }
56
57 virtual void setTargetAttribute(const char * event);
58 virtual const char * getTargetAttribute(void) const { return this->target; }
59
60 virtual void setTargetTypeAttribute(const char * event);
61 virtual const char * getTargetTypeAttribute(void) const { return this->targettype; }
62
63 virtual void setSendIDAttribute(const char * event);
64 virtual const char * getSendIDAttribute(void) const { return this->sendid; }
65
66 virtual void setDelayAttribute(const char * event);
67 virtual const char * getDelayAttribute(void) const { return this->delay; }
68
69 virtual void setNameListAttribute(const char * event);
70 virtual const char * getNameListAttribute(void) const { return this->namelist; }
71
72 virtual void setHintsAttribute(const char * event);
73 virtual const char * getHintsAttribute(void) const { return this->hints; }
74
75 virtual SbBool handleXMLAttributes(void);
76
77 virtual void copyContents(const ScXMLElt * rhs);
78
79 virtual const ScXMLElt * search(const char * attrname, const char * attrvalue) const;
80
81 ScXMLEvent * createEvent(ScXMLEventTarget * host) const;
82
83 virtual void execute(ScXMLStateMachine * statemachine) const;
84
85protected:
86 char * event;
87 char * target;
88 char * targettype;
89 char * sendid;
90 char * delay;
91 char * namelist;
92 char * hints;
93
94private:
95 ScXMLSendElt(const ScXMLSendElt & rhs); // N/A
96 ScXMLSendElt & operator = (const ScXMLSendElt & rhs); // N/A
97
98 class PImpl;
99 SbLazyPimplPtr<PImpl> pimpl;
100
101}; // ScXMLSendElt
102
103#endif // !COIN_SCXMLSENDELT_H
104
SbLazyPimplPtr
Definition SbLazyPimplPtr.h:56
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
ScXMLEventTarget
base class for event targets for inter-system event communication
Definition ScXMLEventTarget.h:43
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
ScXMLSendElt
the < send> SCXML element.
Definition ScXMLSendElt.h:43
ScXMLStateMachine
Manager for processing events and setting states in SCXML structures.
Definition ScXMLStateMachine.h:61