Stimulus.hxx
上传用户:sy_wanhua
上传日期:2013-07-25
资源大小:3048k
文件大小:4k
- #if !defined(STIMULUS_DOT_HXX)
- #define STIMULUS_DOT_HXX
- /* ====================================================================
- * The Vovida Software License, Version 1.0
- *
- * Copyright (c) 2000 Vovida Networks, Inc. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The names "VOCAL", "Vovida Open Communication Application Library",
- * and "Vovida Open Communication Application Library (VOCAL)" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact vocal@vovida.org.
- *
- * 4. Products derived from this software may not be called "VOCAL", nor
- * may "VOCAL" appear in their name, without prior written
- * permission of Vovida Networks, Inc.
- *
- * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
- * NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL VOVIDA
- * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
- * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
- * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
- * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
- * DAMAGE.
- *
- * ====================================================================
- *
- * This software consists of voluntary contributions made by Vovida
- * Networks, Inc. and many individuals on behalf of Vovida Networks,
- * Inc. For more information on Vovida Networks, Inc., please see
- * <http://www.vovida.org/>.
- *
- */
- static const char* const Stimulus_hxx_Version =
- "$Id: Stimulus.hxx,v 1.1 2001/03/30 02:49:20 icahoon Exp $";
- #include "Event.hxx"
- #include "Sptr.hxx"
- #include "Writer.hxx"
- #include <string>
- /** Infrastructure common to VOCAL.
- */
- namespace Vocal
- {
- /** Infrastructure in VOCAL related to "algorithms and the assignment of
- * responsibilities between objects".<br><br>
- *
- * See Design Patterns, ISBN 0-201-63361-2, Chapter 5.
- */
- namespace Behavioral
- {
- /** A stimulus is some type of event (perhaps even an Event) that
- * can drive a finite state machine.<br><br>
- *
- * @see Vocal::Behavioral::Context
- * @see Vocal::Behavioral::StateInterface
- * @see Event
- */
- class Stimulus : public Vocal::IO::Writer
- {
- public:
- /** Create a stimulus, given the id and an optional name.
- */
- Stimulus(
- u_int32_t id,
- const char * name = 0
- );
-
- /** Copy constructor
- */
- Stimulus(const Stimulus &);
- /** Virtual destructor
- */
- virtual ~Stimulus();
- /** Assignment operator
- */
- Stimulus & operator=(const Stimulus &);
- /** Equality relational operator
- */
- bool operator==(const Stimulus &) const;
- /** Less than relational operator
- */
- bool operator<(const Stimulus &) const;
- /** Allows an Event to be associated with this Stimulus.
- */
- void event(Sptr<Vocal::Signaling::Event>);
- /** Event accessor, may be 0 if not Event is associated.
- */
- Sptr<Vocal::Signaling::Event> event() const;
- /** Write the Stimulus to an ostream.
- */
- ostream & writeTo(ostream &) const;
- private:
- u_int32_t id_;
- string name_;
- Sptr<Vocal::Signaling::Event> event_;
- };
- } // namespace Behavioral
- } // namespace Vocal
- #endif // !defined(STIMULUS_DOT_HXX)