Changeset 10690 for trunk/FACT++/src/StateMachineImp.cc
- Timestamp:
- 05/12/11 22:04:32 (14 years ago)
- File:
-
- 1 edited
-
trunk/FACT++/src/StateMachineImp.cc (modified) (9 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/FACT++/src/StateMachineImp.cc
r10688 r10690 512 512 // -------------------------------------------------------------------------- 513 513 // 514 //! Calling this function a new allowed transitionis added to the state514 //! Calling this function, a new (named) event is added to the state 515 515 //! machine. Via a call to CreateEvent a new event is created with the 516 516 //! given targetstate, name and format. … … 520 520 //! 521 521 //! @param targetstate 522 //! Defines the target state of the new transition. If \b must be522 //! Defines the target state (or name) of the new event. If \b must be 523 523 //! greater or equal zero. A negative target state is used to flag 524 524 //! commands which do not initiate a state transition. If this is 525 //! desired use AddEvent instead.525 //! desired use the unnamed version of AddEvent instead. 526 526 //! 527 527 //! @param name … … 556 556 // -------------------------------------------------------------------------- 557 557 // 558 //! Calling this function a new allowed transitionis added to the state558 //! Calling this function, a new (named) event is added to the state 559 559 //! machine. Therefore an instance of type DimEvent is created and added 560 560 //! to the list of available commands fListOfEvents. 561 561 //! 562 562 //! @param targetstate 563 //! Defines the target state of the new transition. If \b must be563 //! Defines the target state (or name) of the new event. If \b must be 564 564 //! greater or equal zero. A negative target state is used to flag 565 565 //! commands which do not initiate a state transition. If this is 566 //! desired use AddEvent instead.566 //! desired use the unnamed version of AddEvent instead. 567 567 //! 568 568 //! @param name … … 584 584 // -------------------------------------------------------------------------- 585 585 // 586 //! Calling this function a new allowed transitionis added to the state586 //! Calling this function, a new (named) event is added to the state 587 587 //! machine. Therefore an instance of type DimEvent is created and added 588 588 //! to the list of available commands fListOfEvents. 589 589 //! 590 590 //! @param targetstate 591 //! Defines the target state of the new transition. If \b must be591 //! Defines the target state (or name) of the new event. If \b must be 592 592 //! greater or equal zero. A negative target state is used to flag 593 593 //! commands which do not initiate a state transition. If this is 594 //! desired use AddEvent instead.594 //! desired use the unnamed version of AddEvent instead. 595 595 //! 596 596 //! @param name … … 618 618 // -------------------------------------------------------------------------- 619 619 // 620 //! This function calls AddEvent with a target-state of -1 which means621 //! that the command will not change the state at all. This shell be used622 //! for configuration commands. As well as in AddEvent the states in623 //! which such a configuration command isaccepted can be given.620 //! This function calls AddEvent with a target-state of -1 (unnamed 621 //! event). This shell be used for configuration commands. As well as 622 //! in AddEvent the states in which such a configuration command is 623 //! accepted can be given. 624 624 //! 625 625 //! @param name … … 645 645 // -------------------------------------------------------------------------- 646 646 // 647 //! This function calls AddEvent with a target-state of -1 which means648 //! that the command will not change the state at all. This shell be used649 //! for configuration commands. As well as in AddEvent the states in650 //! which such a configuration command isaccepted can be given.647 //! This function calls AddEvent with a target-state of -1 (unnamed 648 //! event). This shell be used for configuration commands. As well as 649 //! in AddEvent the states in which such a configuration command is 650 //! accepted can be given. 651 651 //! 652 652 //! @param name … … 666 666 // -------------------------------------------------------------------------- 667 667 // 668 //! This function calls AddEvent with a target-state of -1 which means669 //! that the command will not change the state at all. This shell be used670 //! for configuration commands. As well as in AddEvent the states in671 //! which such a configuration command isaccepted can be given.668 //! This function calls AddEvent with a target-state of -1 (unnamed 669 //! event). This shell be used for configuration commands. As well as 670 //! in AddEvent the states in which such a configuration command is 671 //! accepted can be given. 672 672 //! 673 673 //! @param name … … 883 883 // 884 884 //! This is the event handler. Depending on the type of event it calles 885 //! the function associated with the even et, the Transition() or885 //! the function associated with the event, the Transition() or 886 886 //! Configure() function. 887 887 //! … … 893 893 //! called with its return value. 894 894 //! 895 //! If the event's target state is negative the Configure() function is896 //! called with the event as argument and HandleNewState with its897 //! returned new state.898 //! 899 //! If the event's target state is 0 or positive the Transition() function is900 //! called with the event as argument and HandleNewState with its901 //! returned new state.895 //! If the event's target state is negative (unnamed Event) the Configure() 896 //! function is called with the event as argument and HandleNewState with 897 //! its returned new state. 898 //! 899 //! If the event's target state is 0 or positive (named Event) the 900 //! Transition() function is called with the event as argument and 901 //! HandleNewState with its returned new state. 902 902 //! 903 903 //! In all three cases the return value of HandleNewState is returned.
Note:
See TracChangeset
for help on using the changeset viewer.
