ScXMLTransitionElt.h
#ifndef COIN_SCXMLTRANSITIONELT_H
#define COIN_SCXMLTRANSITIONELT_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/ScXMLElt.h>
#include <Inventor/tools/SbPimplPtr.h>
class ScXMLEvent;
class ScXMLExecutableElt;
class ScXMLStateMachine;
class COIN_DLL_API ScXMLTransitionElt : public ScXMLElt {
typedef ScXMLElt inherited;
SCXML_ELEMENT_HEADER(ScXMLTransitionElt)
public:
static void initClass(void);
static void cleanClass(void);
ScXMLTransitionElt(void);
virtual ~ScXMLTransitionElt(void);
// XML attributes
virtual void setEventAttribute(const char * event);
const char * getEventAttribute(void) const { return this->event; }
virtual void setCondAttribute(const char * cond);
const char * getCondAttribute(void) const { return this->cond; }
virtual void setTargetAttribute(const char * target);
const char * getTargetAttribute(void) const { return this->target; }
virtual void setAnchorAttribute(const char * anchor);
const char * getAnchorAttribute(void) const { return this->anchor; }
virtual SbBool handleXMLAttributes(void);
virtual void copyContents(const ScXMLElt * rhs);
virtual const ScXMLElt * search(const char * attrname, const char * attrvalue) const;
// predicates
SbBool isConditionLess(void) const;
SbBool isTargetLess(void) const;
SbBool isSelfReferencing(void) const;
// check
virtual SbBool isEventMatch(const ScXMLEvent * event) const;
// isConditionMatch() ?
virtual SbBool evaluateCondition(ScXMLStateMachine * statemachine);
// executable content
virtual int getNumExecutables(void) const;
virtual ScXMLExecutableElt * getExecutable(int idx) const;
virtual void addExecutable(ScXMLExecutableElt * executable);
virtual void removeExecutable(ScXMLExecutableElt * executable);
virtual void clearAllExecutables(void);
virtual void execute(ScXMLStateMachine * statemachine) const;
protected:
char * event;
char * cond;
char * target;
char * anchor;
SbBool needprefixmatching;
SbName eventkey;
SbName targetkey;
private:
ScXMLTransitionElt(const ScXMLTransitionElt & rhs); // N/A
ScXMLTransitionElt & operator = (const ScXMLTransitionElt & rhs); // N/A
class PImpl;
SbPimplPtr<PImpl> pimpl;
}; // ScXMLTransitionElt
#endif // !COIN_SCXMLTRANSITIONELT_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SbPimplPtr
Definition SbPimplPtr.h:55
ScXMLElt::search
virtual const ScXMLElt * search(const char *attrname, const char *attrvalue) const
Definition ScXMLElt.cpp:214
ScXMLElt::handleXMLAttributes
virtual SbBool handleXMLAttributes(void)
Definition ScXMLElt.cpp:200
ScXMLEvent
Base class for events sent to SCXML state machines.
Definition ScXMLEvent.h:40
ScXMLExecutableElt
base class for all SCXML elements with executable content.
Definition ScXMLExecutableElt.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
ScXMLStateMachine
Manager for processing events and setting states in SCXML structures.
Definition ScXMLStateMachine.h:61
ScXMLTransitionElt::isTargetLess
SbBool isTargetLess(void) const
Definition ScXMLTransitionElt.cpp:457
ScXMLTransitionElt::isSelfReferencing
SbBool isSelfReferencing(void) const
Definition ScXMLTransitionElt.cpp:473
ScXMLTransitionElt::evaluateCondition
virtual SbBool evaluateCondition(ScXMLStateMachine *statemachine)
Definition ScXMLTransitionElt.cpp:524
ScXMLTransitionElt::isEventMatch
virtual SbBool isEventMatch(const ScXMLEvent *event) const
Definition ScXMLTransitionElt.cpp:487
ScXMLTransitionElt::execute
virtual void execute(ScXMLStateMachine *statemachine) const
Definition ScXMLTransitionElt.cpp:567
ScXMLTransitionElt::isConditionLess
SbBool isConditionLess(void) const
Definition ScXMLTransitionElt.cpp:441