Coin Logo http://www.coin3d.org/
http://www.kongsberg.com/kogt/

ScXMLEvent.h
1 #ifndef COIN_SCXMLEVENT_H
2 #define COIN_SCXMLEVENT_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/SbLazyPimplPtr.h>
38 #include <Inventor/lists/SbList.h>
39 
40 class COIN_DLL_API ScXMLEvent : public ScXMLObject {
41  typedef ScXMLObject inherited;
42  SCXML_OBJECT_HEADER(ScXMLEvent)
43 
44 public:
45  static void initClass(void);
46  static void cleanClass(void);
47 
48  ScXMLEvent(void);
49  virtual ~ScXMLEvent(void);
50 
51  virtual void setEventName(const SbName & name);
52  const SbName & getEventName(void) const { return this->name; }
53 
54  ScXMLEvent * clone(void) const;
55 
56  // associations
57  void setAssociation(const char * key, const char * value);
58  const char * getAssociation(const char * key) const;
59 
60  size_t getNumAssociations(void) const;
61  size_t getAssociationKeys(SbList<const char *> & keys) const;
62 
63 protected:
64  SbName name;
65 
66  virtual void copyContents(const ScXMLEvent * rhs);
67 
68 private:
69  ScXMLEvent(const ScXMLEvent & rhs); // N/A
70  ScXMLEvent & operator = (const ScXMLEvent & rhs); // N/A
71 
72  class PImpl;
73  SbLazyPimplPtr<PImpl> pimpl;
74 }; // ScXMLEvent
75 
76 #endif // !COIN_SCXMLEVENT_H
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
The SbName class stores strings by reference.The class is used by Coin for storing keywords...
Definition: SbName.h:40

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen