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

ScXMLDocument.h
1 #ifndef COIN_SCXMLDOCUMENT_H
2 #define COIN_SCXMLDOCUMENT_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 
38 #include <Inventor/tools/SbPimplPtr.h>
39 
40 class SbByteBuffer;
41 class ScXMLScxmlElt;
43 class ScXMLDataElt;
44 
45 struct cc_xml_doc;
46 
47 class COIN_DLL_API ScXMLDocument : public ScXMLObject {
48  typedef ScXMLObject inherited;
49  SCXML_OBJECT_HEADER(ScXMLDocument)
50 
51 public:
52  static void initClass(void);
53  static void cleanClass(void);
54 
55  static ScXMLDocument * readFile(const char * filename);
56  static ScXMLDocument * readBuffer(const SbByteBuffer & buffer);
57  static ScXMLDocument * readXMLData(cc_xml_doc * xmldoc);
58 
59  ScXMLDocument(void);
60  virtual ~ScXMLDocument(void);
61 
62  void setFilename(const char * filename);
63  const char * getFilename(void) const;
64 
65  virtual void setRoot(ScXMLScxmlElt * root);
66  ScXMLScxmlElt * getRoot(void) const;
67 
68  ScXMLAbstractStateElt * getStateById(SbName id) const;
69  ScXMLDataElt * getDataById(SbName id) const;
70 
71 protected:
72 
73 private:
74  ScXMLDocument(const ScXMLDocument & rhs); // N/A
75  ScXMLDocument & operator = (const ScXMLDocument & rhs); // N/A
76 
77  class PImpl;
78  SbPimplPtr<PImpl> pimpl;
79 
80 }; // ScXMLDocument
81 
82 #endif // COIN_SCXMLDOCUMENT_H
the <data> SCXML element.
Definition: ScXMLDataElt.h:42
abstract base class for the SCXML &#39;state&#39; elements.
Definition: ScXMLAbstractStateElt.h:40
implements the <scxml> SCXML element.
Definition: ScXMLScxmlElt.h:47
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition: ScXMLObject.cpp:102
Definition: ScXMLDocument.h:47
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
struct cc_xml_doc cc_xml_doc
opaque container object type for XML documents
Definition: types.h:43
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