import "RTC.idl";
Public Member Functions | |
| ReturnCode_t | send_stimulus (in string message, in ExecutionContextHandle_t exec_handle) |
| send_stimulus | |
The FsmObject interface allows programs to send stimuli to a finite state machine, possibly causing it to change states.
| ReturnCode_t RTC::FsmObject::send_stimulus | ( | in string | message, | |
| in ExecutionContextHandle_t | exec_handle | |||
| ) |
send_stimulus
Send a stimulus to an FSM that realizes this interface.
If the stimulus corresponds to any outgoing transition of the current state, that transition shall be taken and the state shall change. Any FSM participants associated with the exit of the current state, the transition to the new state, or the entry to the new state shall be invoked. If the stimulus does not correspond to any such transition, this operation shall succeed but have no effect.
If the given execution context is a non-nil reference to a context in which this FSM participates, the transition shall be executed in that context. If the argument is nil, the FSM shall choose an EVENT_DRIVEN context in which to execute the transition. If the argument is non-nil, but this FSM does not participate in the given context, this operation shall fail with * ReturnCode_t::BAD_PARAMETER.
1.6.3