table of contents
other versions
- jessie 3.1.4~abc9f50-7
ScXMLTransitionElt(3) | Coin | ScXMLTransitionElt(3) |
NAME¶
ScXMLTransitionElt - the <transition> SCXML element.SYNOPSIS¶
#include <Inventor/scxml/ScXMLTransitionElt.h> Inherits ScXMLElt.Public Member Functions¶
virtual SoType getTypeId (void) const
Static Public Member Functions¶
static ScXMLEltReader * getElementReader (void)
Protected Attributes¶
char * event
Additional Inherited Members¶
Detailed Description¶
the <transition> SCXML element. The <transition> element is used for invoking executable code and transition from the current active states in a state machine to a new set of active states. By plural active states, it is meant that all the parent states of active states are also active at the same time, which is helpful when organizing common event triggered <transition> transitions. Putting transitions in the root <scxml> element means that they are always active. You also have the concept of parallel states in SCXML. This is not yet supported in Coin SCXML. The following attributes are accepted:- •
- event
- •
- cond
- •
- target
- •
- anchor - not supported
- •
- '*' must be at the end of the event name match.
- •
- '*' must match full dot-separated words.
Coin 3.0
See also:
ScXMLIfElt, ScXMLAssignElt,
ScXMLSendElt, ScXMLEventElt, ScXMLLogElt
Member Function Documentation¶
SoType ScXMLTransitionElt::getTypeId (void) const [virtual]¶
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. See also:SoBase::getTypeId() const
Implements ScXMLElt.
SbBool ScXMLTransitionElt::handleXMLAttributes (void) [virtual]¶
This method is called when the file reader has set all the XML attributes on the object, and wants the object to handle them and report if the values were ok or if a read error should be produced. Returns:TRUE if the attributes are ok, and FALSE on error.
This base class implementation does nothing and just returns TRUE.
Reimplemented from ScXMLElt.
const ScXMLElt * ScXMLTransitionElt::search (const char *attrname, const char *attrvalue) const [virtual]¶
This method searches the SCXML structure for an element with the given attributevalue for the given attribute. Returns NULL if nothing was found. This function needs to be reimplemented to traverse child elements. Reimplemented from ScXMLElt.SbBool ScXMLTransitionElt::isConditionLess (void) const¶
Returns whether this is a conditionless SCXML transition or not. A conditionless transition should always be taken.SbBool ScXMLTransitionElt::isTargetLess (void) const¶
Returns whether this is a transition without a target setting or not. When a targetless transition is taken, the state machine's state does not change. This differs from setting the target to its own state, which will cause the state machine to leave the state and reenter it again.SbBool ScXMLTransitionElt::isSelfReferencing (void) const¶
Returns whether this transition is referencing its container or not. If TRUE, this means you should end up in the same state as you started with when doing this transition. Note however that as opposed to a targetless transition, this transition should actually exit the state and then reenter it again. Executable content will be invoked after exiting the state, before reentering.SbBool ScXMLTransitionElt::isEventMatch (const ScXMLEvent *eventobj) const [virtual]¶
This function returns TRUE if the transition matches the given eventobj object and FALSE otherwise.SbBool ScXMLTransitionElt::evaluateCondition ( ScXMLStateMachine *statemachine) [virtual]¶
This function uses the statemachine evaluator to evaluate its condition expression, and returns TRUE or FALSE based on the evaluation. On expression error, error events are emit'ed to the SCXML state machine. If the transition is conditionless, this function will return TRUE.void ScXMLTransitionElt::execute ( ScXMLStateMachine *statemachine) const [virtual]¶
Calls invoke on all the ScXMLInvoke children.Author¶
Generated automatically by Doxygen for Coin from the source code.Thu May 29 2014 | Version 4.0.0a |