ScXMLStateElt.h
#ifndef COIN_SCXMLSTATEELT_H
#define COIN_SCXMLSTATEELT_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/ScXMLAbstractStateElt.h>
#include <Inventor/tools/SbPimplPtr.h>
class ScXMLOnEntryElt;
class ScXMLOnExitElt;
class ScXMLTransitionElt;
class ScXMLStateElt;
class ScXMLParallelElt;
class ScXMLInitialElt;
class ScXMLFinalElt;
class ScXMLHistoryElt;
class ScXMLDataModelElt;
class ScXMLAnchorElt;
class ScXMLStateMachine;
class COIN_DLL_API ScXMLStateElt : public ScXMLAbstractStateElt {
typedef ScXMLAbstractStateElt inherited;
SCXML_ELEMENT_HEADER(ScXMLStateElt)
public:
static void initClass(void);
static void cleanClass(void);
ScXMLStateElt(void);
virtual ~ScXMLStateElt(void);
// XML attributes
virtual void setSrcAttribute(const char * src);
const char * getSrcAttribute(void) const { return this->src; }
virtual void setInitialAttribute(const char * initial);
const char * getInitialAttribute(void) const { return this->initial; }
virtual SbBool handleXMLAttributes(void);
virtual void copyContents(const ScXMLElt * rhs);
virtual const ScXMLElt * search(const char * attrname, const char * attrvalue) const;
// children...
virtual void setOnEntry(ScXMLOnEntryElt * onentry);
virtual ScXMLOnEntryElt * getOnEntry(void) const;
virtual void setOnExit(ScXMLOnExitElt * onexit);
virtual ScXMLOnExitElt * getOnExit(void) const;
virtual int getNumTransitions(void) const;
virtual ScXMLTransitionElt * getTransition(int idx) const;
virtual void addTransition(ScXMLTransitionElt * transition);
virtual void removeTransition(ScXMLTransitionElt * transition);
virtual void clearAllTransitions(void);
virtual void setInitial(ScXMLInitialElt * initial);
virtual ScXMLInitialElt * getInitial(void) const;
virtual int getNumStates(void) const;
virtual ScXMLStateElt * getState(int idx) const;
virtual void addState(ScXMLStateElt * state);
virtual void removeState(ScXMLStateElt * state);
virtual void clearAllStates(void);
virtual int getNumParallels(void) const;
virtual ScXMLParallelElt * getParallel(int idx) const;
virtual void addParallel(ScXMLParallelElt * state);
virtual void removeParallel(ScXMLParallelElt * state);
virtual void clearAllParallels(void);
virtual int getNumFinals(void) const;
virtual ScXMLFinalElt * getFinal(int idx) const;
virtual void addFinal(ScXMLFinalElt * state);
virtual void removeFinal(ScXMLFinalElt * state);
virtual void clearAllFinals(void);
virtual int getNumHistories(void) const;
virtual ScXMLHistoryElt * getHistory(int idx) const;
virtual void addHistory(ScXMLHistoryElt * history);
virtual void removeHistory(ScXMLHistoryElt * history);
virtual void clearAllHistories(void);
virtual int getNumAnchors(void) const;
virtual ScXMLAnchorElt * getAnchor(int idx) const;
virtual void addAnchor(ScXMLAnchorElt * anchor);
virtual void removeAnchor(ScXMLAnchorElt * anchor);
virtual void clearAllAnchors(void);
virtual void setDataModel(ScXMLDataModelElt * datamodel);
virtual ScXMLDataModelElt * getDataModel(void) const;
SbBool isAtomicState(void) const;
protected:
char * src;
char * initial;
private:
ScXMLStateElt(const ScXMLStateElt & rhs); // N/A
ScXMLStateElt & operator = (const ScXMLStateElt & rhs); // N/A
class PImpl;
SbPimplPtr<PImpl> pimpl;
}; // ScXMLStateElt
#endif // !COIN_SCXMLSTATEELT_H
SbPimplPtr
Definition SbPimplPtr.h:55
ScXMLAbstractStateElt::search
virtual const ScXMLElt * search(const char *attrname, const char *attrvalue) const
Definition ScXMLAbstractStateElt.cpp:117
ScXMLAbstractStateElt::handleXMLAttributes
virtual SbBool handleXMLAttributes(void)
Definition ScXMLAbstractStateElt.cpp:90
ScXMLAnchorElt
implements the <anchor> SCXML element.
Definition ScXMLAnchorElt.h:40
ScXMLDataModelElt
implements the <datamodel> SCXML element.
Definition ScXMLDataModelElt.h:42
ScXMLElt
base class for all SCXML elements.
Definition ScXMLElt.h:44
ScXMLFinalElt
implements the <final> SCXML element.
Definition ScXMLFinalElt.h:42
ScXMLHistoryElt
implements the <history> SCXML element.
Definition ScXMLHistoryElt.h:42
ScXMLInitialElt
implements the <initial> SCXML element.
Definition ScXMLInitialElt.h:41
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
ScXMLOnEntryElt
implements the <onentry> SCXML element.
Definition ScXMLOnEntryElt.h:43
ScXMLOnExitElt
implements the <onexit> SCXML element.
Definition ScXMLOnExitElt.h:43
ScXMLParallelElt
implements the <parallel> SCXML element.
Definition ScXMLParallelElt.h:51
ScXMLStateElt
implements the <state> SCXML element.
Definition ScXMLStateElt.h:51
ScXMLStateElt::getSrcAttribute
const char * getSrcAttribute(void) const
Definition ScXMLStateElt.h:64
ScXMLStateElt::getInitialAttribute
const char * getInitialAttribute(void) const
Definition ScXMLStateElt.h:67
ScXMLStateElt::ScXMLStateElt
ScXMLStateElt(void)
Definition ScXMLStateElt.cpp:554
ScXMLStateElt::setSrcAttribute
virtual void setSrcAttribute(const char *src)
Definition ScXMLStateElt.cpp:575
ScXMLStateMachine
Manager for processing events and setting states in SCXML structures.
Definition ScXMLStateMachine.h:61
ScXMLTransitionElt
the <transition> SCXML element.
Definition ScXMLTransitionElt.h:43