The OMState class
defines methods that affect statecharts.
This
class is defined in the header file state.h.
Attribute summary- parent
- Specifies the parent
Construction summary- OMState
- Constructs an OMState object
Macro summary
- IS_EVENT_TYPE_OF(id)
- supports generic derived
event handling
- OM_DECLARE_FRAMEWORK_MEMOR Y_ALLOCATION_OPERATORS
- supports enhanced user control over framework memory allocation
Method
summary- entDef
- Specifies the operation called when the state is
entered from a default transition
- entHist
- Enters a history connector
- enterState
- Specifies the state entry action
- exitState
- Specifies the state exit
action
- getConcept
- Gets the statechart owner
- getHandle
- Gets the handle
- getLastState
- Gets the last state
- isCompleted
- Gets the substate
- in
- Returns TRUE when the owner class
is in this state
- isCompleted
- Determines whether the OR state
reached a final state, and therefore can be exited on a null transition
- serializeStates
- Is called during animation to send state information
- setHandle
- Sets the handle
- setLastState
- Sets the last state
- setSubState
- Sets the substate
- takeEvent
- Takes the specified event off the event queue
Attributesparent
This attribute specifies the parent state of this state
(the state this state is contained in). It is defined as follows:
OMState* parent;
MacrosIS_EVENT_TYPE_OF(id)
This macro helps support generic derived event handling.
Rational® Rhapsody® provides a generic
way to handle the consumption of derived events. The support in generic
handling of derived events was done by adding a new method, isTypeOf(),
for every event, and modifying the generated code to check the event
using this method. The isTypeOf() method returns True for
derived events, as well as for the actual event.
OM_DECLARE_FRAMEWORK_MEMORY_ALLOCATION_OPERATORS
This macro helps support user control over framework
memory allocation.
Rational Rhapsody supports
application control over memory allocated in the framework in two
ways:
- Complete the memory management coverage,
so every
memory allocation in the generic framework as well as all the RTOS
adaptors is using the memory management mechanism.
- Complete
the usage of the returnMemory() interface,
so the memory size returned is passed.