StateInterface.hxx
上传用户:sy_wanhua
上传日期:2013-07-25
资源大小:3048k
文件大小:6k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(STATEINTERFACE_DOT_H)
  2. #define STATEINTERFACE_DOT_H
  3. /* ====================================================================
  4.  * The Vovida Software License, Version 1.0 
  5.  * 
  6.  * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
  7.  * 
  8.  * Redistribution and use in source and binary forms, with or without
  9.  * modification, are permitted provided that the following conditions
  10.  * are met:
  11.  * 
  12.  * 1. Redistributions of source code must retain the above copyright
  13.  *    notice, this list of conditions and the following disclaimer.
  14.  * 
  15.  * 2. Redistributions in binary form must reproduce the above copyright
  16.  *    notice, this list of conditions and the following disclaimer in
  17.  *    the documentation and/or other materials provided with the
  18.  *    distribution.
  19.  * 
  20.  * 3. The names "VOCAL", "Vovida Open Communication Application Library",
  21.  *    and "Vovida Open Communication Application Library (VOCAL)" must
  22.  *    not be used to endorse or promote products derived from this
  23.  *    software without prior written permission. For written
  24.  *    permission, please contact vocal@vovida.org.
  25.  *
  26.  * 4. Products derived from this software may not be called "VOCAL", nor
  27.  *    may "VOCAL" appear in their name, without prior written
  28.  *    permission of Vovida Networks, Inc.
  29.  * 
  30.  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
  31.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
  33.  * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
  34.  * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
  35.  * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
  36.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  37.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  38.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  39.  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  41.  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  42.  * DAMAGE.
  43.  * 
  44.  * ====================================================================
  45.  * 
  46.  * This software consists of voluntary contributions made by Vovida
  47.  * Networks, Inc. and many individuals on behalf of Vovida Networks,
  48.  * Inc.  For more information on Vovida Networks, Inc., please see
  49.  * <http://www.vovida.org/>.
  50.  *
  51.  */
  52. static const char* const StateInterface_hxx_Version = 
  53.     "$Id: StateInterface.hxx,v 1.1 2001/03/30 02:49:20 icahoon Exp $";
  54. #include <map>
  55. #include <string>
  56. #include "Writer.hxx"
  57. #include "Stimulus.hxx"
  58. /** Infrastructure common to VOCAL.
  59.  */
  60. namespace Vocal 
  61. {
  62. /** Infrastructure in VOCAL related to "algorithms and the assignment of
  63.  *  responsibilities between objects".<br><br>
  64.  *
  65.  *  See Design Patterns, ISBN 0-201-63361-2, Chapter 5.
  66.  */
  67. namespace Behavioral
  68. {
  69. class Action;
  70. /** A concrete class representing a state in a finite state machine.<br><br>
  71.  *
  72.  *  The state allows an entry Action to be specified such that upon entry
  73.  *  into the state, the entry action will be executed. The state also allows
  74.  *  an exit action to be specified such that upon leaving the state, the
  75.  *  exit action will be executed.<br><br>
  76.  *
  77.  *  A state will respond to a given Stimulus by performing a series of Actions
  78.  *
  79.  *
  80.  *
  81.  *  @see    Vocal::Behavioral::Stimulus
  82.  *  @see    Vocal::Behavioral::Context
  83.  *  @see    Vocal::Behavioral::Action
  84.  */
  85. class StateInterface : public Vocal::IO::Writer
  86. {
  87.     public:
  88.      /** Contruct the state, given an optional name, given an optional
  89.  *  entry action, and given an optional exit action.
  90.  */
  91.         StateInterface(
  92.     const char      *  name = 0,
  93.     Action       * entry  = 0,
  94.     Action       * exit  = 0
  95. );
  96.      /** Virtual destructor.
  97.  */
  98. virtual     ~StateInterface();
  99.      /** For the given Stimulus, the Action will be executed, and the
  100.  *  state machine will transition to the nextState.
  101.  */
  102. void     addAction(
  103.           const Stimulus      & stimulus,
  104. Action       & action,
  105.           StateInterface      & nextState
  106.     );
  107.      /** For the given Stimulus, the Action will be executed. If the
  108.  *  Action was successful, it will transition to the nextState, 
  109.  *  otherwise it will transition to the nextStateOnFail.
  110.  *
  111.  *  This is used only for conditional state transitions, where
  112.  *  an action may fail depending on external data associated
  113.  *  with the stimulus.
  114.  */
  115. void     addAction(
  116.           const Stimulus      & stimulus,
  117. Action       & action,
  118.           StateInterface      & nextState,
  119. StateInterface     & nextStateOnFail
  120.     );
  121.      /** Associate an entry action to be performed.
  122.  */
  123.      void             entryAction(Action &);
  124.      /** Associate an exit action to be performed.
  125.  */
  126.      void             exitAction(Action &);
  127.      /** Called when entering this state.
  128.  */
  129.      virtual void        enter() throw ();
  130.      /** Called to handle the given stimulus.
  131.  */
  132.      StateInterface &    stimulate(
  133.                const Stimulus  &   stimulus
  134.     ) throw ();
  135.      /** Called when exiting the state.
  136.  */
  137. virtual void     exit() throw();
  138.      /** Write the state to an ostream.
  139.  */
  140. virtual ostream &   writeTo(ostream &) const;
  141.      /** Returns the instance specific name, if given during construction.
  142.  */
  143.      virtual const string &     name() const;
  144.     private:
  145.      class StimulusData
  146. {
  147.     public:
  148.          StimulusData(
  149. Action       & action,
  150.           StateInterface      & nextState,
  151.                StateInterface     * nextStateOnFail
  152.     );
  153.           Action       & action_;
  154.           StateInterface      & nextState_;
  155.           StateInterface      * nextStateOnFail_;
  156. };
  157.      typedef map<Stimulus, StimulusData>    StimulusTable;
  158.      typedef pair<Stimulus, StimulusData>   StimulusPair;
  159. StimulusTable        stimulusTable_;
  160.      string           name_;
  161.      Action          * entry_;
  162.      Action          * exit_;
  163.      // Suppress copying
  164. //
  165.         StateInterface(const StateInterface &);
  166. StateInterface & operator=(const StateInterface &);
  167. };
  168. } // namespace Behavioral
  169. } // namespace Vocal
  170. #endif // !defined(STATEINTERFACE_DOT_H)