Changeset 10690 for trunk


Ignore:
Timestamp:
05/12/11 22:04:32 (14 years ago)
Author:
tbretz
Message:
Updated docu according to latest changes.
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/FACT++/src/StateMachineImp.cc

    r10688 r10690  
    512512// --------------------------------------------------------------------------
    513513//
    514 //! Calling this function a new allowed transition is added to the state
     514//! Calling this function, a new (named) event is added to the state
    515515//! machine. Via a call to CreateEvent a new event is created with the
    516516//! given targetstate, name and format.
    … …  
    520520//!
    521521//! @param targetstate
    522 //!    Defines the target state of the new transition. If \b must be
     522//!    Defines the target state (or name) of the new event. If \b must be
    523523//!    greater or equal zero. A negative target state is used to flag
    524524//!    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.
    526526//!
    527527//! @param name
    … …  
    556556// --------------------------------------------------------------------------
    557557//
    558 //! Calling this function a new allowed transition is added to the state
     558//! Calling this function, a new (named) event is added to the state
    559559//! machine. Therefore an instance of type DimEvent is created and added
    560560//! to the list of available commands fListOfEvents.
    561561//!
    562562//! @param targetstate
    563 //!    Defines the target state of the new transition. If \b must be
     563//!    Defines the target state (or name) of the new event. If \b must be
    564564//!    greater or equal zero. A negative target state is used to flag
    565565//!    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.
    567567//!
    568568//! @param name
    … …  
    584584// --------------------------------------------------------------------------
    585585//
    586 //! Calling this function a new allowed transition is added to the state
     586//! Calling this function, a new (named) event is added to the state
    587587//! machine. Therefore an instance of type DimEvent is created and added
    588588//! to the list of available commands fListOfEvents.
    589589//!
    590590//! @param targetstate
    591 //!    Defines the target state of the new transition. If \b must be
     591//!    Defines the target state (or name) of the new event. If \b must be
    592592//!    greater or equal zero. A negative target state is used to flag
    593593//!    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.
    595595//!
    596596//! @param name
    … …  
    618618// --------------------------------------------------------------------------
    619619//
    620 //! This function calls AddEvent with a target-state of -1 which means
    621 //! that the command will not change the state at all. This shell be used
    622 //! for configuration commands. As well as in AddEvent the states in
    623 //! which such a configuration command is accepted 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.
    624624//!
    625625//! @param name
    … …  
    645645// --------------------------------------------------------------------------
    646646//
    647 //! This function calls AddEvent with a target-state of -1 which means
    648 //! that the command will not change the state at all. This shell be used
    649 //! for configuration commands. As well as in AddEvent the states in
    650 //! which such a configuration command is accepted 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.
    651651//!
    652652//! @param name
    … …  
    666666// --------------------------------------------------------------------------
    667667//
    668 //! This function calls AddEvent with a target-state of -1 which means
    669 //! that the command will not change the state at all. This shell be used
    670 //! for configuration commands. As well as in AddEvent the states in
    671 //! which such a configuration command is accepted 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.
    672672//!
    673673//! @param name
    … …  
    883883//
    884884//! This is the event handler. Depending on the type of event it calles
    885 //! the function associated with the evenet, the Transition() or
     885//! the function associated with the event, the Transition() or
    886886//! Configure() function.
    887887//!
    … …  
    893893//! called with its return value.
    894894//!
    895 //! If the event's target state is negative the Configure() function is
    896 //! called with the event as argument and HandleNewState with its
    897 //! returned new state.
    898 //!
    899 //! If the event's target state is 0 or positive the Transition() function is
    900 //! called with the event as argument and HandleNewState with its
    901 //! 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.
    902902//!
    903903//! In all three cases the return value of HandleNewState is returned.
Note: See TracChangeset for help on using the changeset viewer.