qhsm_in.cpp

00001 //////////////////////////////////////////////////////////////////////////////
00002 // Product: QEP/C++
00003 // Last Updated for Version: 4.0.02
00004 // Date of the Last Update:  Oct 27, 2008
00005 //
00006 //                    Q u a n t u m     L e a P s
00007 //                    ---------------------------
00008 //                    innovating embedded systems
00009 //
00010 // Copyright (C) 2002-2008 Quantum Leaps, LLC. All rights reserved.
00011 //
00012 // This software may be distributed and modified under the terms of the GNU
00013 // General Public License version 2 (GPL) as published by the Free Software
00014 // Foundation and appearing in the file GPL.TXT included in the packaging of
00015 // this file. Please note that GPL Section 2[b] requires that all works based
00016 // on this software must also be made publicly available under the terms of
00017 // the GPL ("Copyleft").
00018 //
00019 // Alternatively, this software may be distributed and modified under the
00020 // terms of Quantum Leaps commercial licenses, which expressly supersede
00021 // the GPL and are specifically designed for licensees interested in
00022 // retaining the proprietary status of their code.
00023 //
00024 // Contact information:
00025 // Quantum Leaps Web site:  http://www.quantum-leaps.com
00026 // e-mail:                  info@quantum-leaps.com
00027 //////////////////////////////////////////////////////////////////////////////
00028 #include "qep_pkg.h"
00029 
00030 /// \file
00031 /// \ingroup qep
00032 /// \brief QHsm::isIn() implementation.
00033 
00034 //............................................................................
00035 uint8_t QHsm::isIn(QStateHandler state) {
00036     QStateHandler s = m_state;
00037     QState r;
00038     uint8_t inState = (uint8_t)0;    // assume that this HSM is not in 'state'
00039     do {
00040         if (m_state == state) {                        // do the states match?
00041             inState = (uint8_t)1;                  // match found, return TRUE
00042             r = Q_RET_IGNORED;                        // break out of the loop
00043         }
00044         else {
00045             r = QEP_TRIG_(m_state, QEP_EMPTY_SIG_);
00046         }
00047     } while (r != Q_RET_IGNORED);                // QHsm_top state not reached
00048     m_state = s;                                 // restore the original state
00049     return inState;                                       // return the status
00050 }