ScXMLDocument.h
#ifndef COIN_SCXMLDOCUMENT_H
#define COIN_SCXMLDOCUMENT_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/scxml/ScXMLObject.h>
#include <Inventor/tools/SbPimplPtr.h>
class SbByteBuffer;
class ScXMLScxmlElt;
class ScXMLAbstractStateElt;
class ScXMLDataElt;
struct cc_xml_doc;
class COIN_DLL_API ScXMLDocument : public ScXMLObject {
typedef ScXMLObject inherited;
SCXML_OBJECT_HEADER(ScXMLDocument)
public:
static void initClass(void);
static void cleanClass(void);
static ScXMLDocument * readFile(const char * filename);
static ScXMLDocument * readBuffer(const SbByteBuffer & buffer);
static ScXMLDocument * readXMLData(cc_xml_doc * xmldoc);
ScXMLDocument(void);
virtual ~ScXMLDocument(void);
void setFilename(const char * filename);
const char * getFilename(void) const;
virtual void setRoot(ScXMLScxmlElt * root);
ScXMLScxmlElt * getRoot(void) const;
ScXMLAbstractStateElt * getStateById(SbName id) const;
ScXMLDataElt * getDataById(SbName id) const;
protected:
private:
ScXMLDocument(const ScXMLDocument & rhs); // N/A
ScXMLDocument & operator = (const ScXMLDocument & rhs); // N/A
class PImpl;
SbPimplPtr<PImpl> pimpl;
}; // ScXMLDocument
#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