Coin: ScXMLDocument.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/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
40class SbByteBuffer;
41class ScXMLScxmlElt;
42class ScXMLAbstractStateElt;
43class ScXMLDataElt;
44
45struct cc_xml_doc;
46
47 class COIN_DLL_API ScXMLDocument : public ScXMLObject {
48 typedef ScXMLObject inherited;
49 SCXML_OBJECT_HEADER(ScXMLDocument)
50
51public:
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
71protected:
72
73private:
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
SbByteBuffer
Definition SbByteBuffer.h:34
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SbPimplPtr
Definition SbPimplPtr.h:55
ScXMLAbstractStateElt
abstract base class for the SCXML 'state' elements.
Definition ScXMLAbstractStateElt.h:40
ScXMLDataElt
the <data> SCXML element.
Definition ScXMLDataElt.h:42
ScXMLObject::cleanClass
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
ScXMLObject::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition ScXMLObject.cpp:102
ScXMLScxmlElt
implements the <scxml> SCXML element.
Definition ScXMLScxmlElt.h:47