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

流媒体/Mpeg4/MP4

开发平台:

C/C++

  1. #if !defined(ACTION_DOT_H)
  2. #define ACTION_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 Action_hxx_Version = 
  53.     "$Id: Action.hxx,v 1.1 2001/03/30 02:49:20 icahoon Exp $";
  54. #include "VocalCommon.hxx"
  55. #include "Writer.hxx"
  56. /** Infrastructure common to VOCAL.
  57.  */
  58. namespace Vocal 
  59. {
  60. /** Infrastructure in VOCAL related to "algorithms and the assignment of
  61.  *  responsibilities between objects".<br><br>
  62.  *
  63.  *  See Design Patterns, ISBN 0-201-63361-2, Chapter 5.
  64.  */
  65. namespace Behavioral
  66. {
  67. class Stimulus;
  68. /** An Action object is used to implement an algorithm.<br><br>
  69.  *
  70.  *  Actions can be chained one after another.<br><br>
  71.  *
  72.  *  An example use of an Action can be seen in StateInterface class.
  73.  *  The StateInterface, rather than implementing each response to 
  74.  *  a Stimulus with a method, associates an Action with each Stimulus.
  75.  *  The Action is a more discrete element than a state, and therefore
  76.  *  Actions can be shared among many StateInterfaces or perhaps many
  77.  *  state machines.
  78.  *  <br><br>
  79.  *
  80.  *  @see    Vocal::Behavioral::StateInterface
  81.  *  @see    Vocal::Behavioral::Stimulus
  82.  *  @see    Vocal::IO::Writer
  83.  *  @see    Vocal::ReturnCode
  84.  *
  85.  */
  86. class Action : public Vocal::IO::Writer
  87. {
  88.     public:
  89.      /** Default constructor. By default, no actions are chained.
  90.  */
  91.      Action();
  92. /** Virtual destructor, since you should be extending this class.
  93.  */
  94. virtual ~Action();
  95.      /** The public interface to all Actions are the action() methods.
  96.  *  This method call's this classes onAction method, and then if 
  97.  *  another Action is chained to this one, calls the action method 
  98.  *  on the chained Action. This variation allows an action() to be
  99.  *  called without a Stimulus.
  100.  */
  101.      ReturnCode        action() throw ();
  102.      /** The public interface to all Actions are the action() methods.
  103.  *  This method call's this classes onAction method, and then if 
  104.  *  another Action is chained to this one, calls the action method 
  105.  *  on the chained Action. This action to be
  106.  *  called without a Stimulus.
  107.  */
  108.      ReturnCode        action(const Stimulus &) throw ();
  109.      /** Creates an association between this Action and the chained Action,
  110.  *  such that the chained Action will be done after this one.
  111.  */
  112.      virtual void      chain(Action &);
  113.      /** Enabled writing this Action to an ostream. By default writes the
  114.  *  name().
  115.  */
  116. virtual ostream &    writeTo(ostream &) const;
  117. /** The name of the Action. Useful for logging.
  118.  */
  119.      virtual const char * name() const;
  120.     protected:
  121.      /** Method to be extended by the user of this class. Used by action().
  122.  */
  123.      virtual ReturnCode   onAction(const Stimulus * = 0) throw();
  124.      // Used for chaining.
  125. //
  126.      Action          * nextAction_;
  127. };
  128. } // namespace Behavioral
  129. } // namespace Vocal
  130. #endif // !defined(ACTION_DOT_H)