Helper.h

Go to the documentation of this file.

 
/*
 *    scampl4cpp/engine
 *
 *    Copyright by European Southern Observatory, 2012
 *    All rights reserved
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 *    02111-1307 USA.
 */
 
#ifndef SCXML4CPP_HELPER_H
#define SCXML4CPP_HELPER_H
 
#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif
 
#include <list>
#include <set>
#include <vector>
#include <string>
 
namespace scxml4cpp {
 
class Transition;
class StateMachine;
class State;
class Action;
class Activity;
class Event;

class Helper {
   public:
    Helper();

    ~Helper();

    const std::string printStateType(State* s);

    const std::string printTransition(Transition* t);

    const std::string printTransitions(std::list<Transition*>& transitions);

    const std::string printTargetState(Transition* transitions);

    const std::string printTargetStates(std::list<Transition*>& transitions);

    const std::string printActions(std::list<Action*>& actions);

    const std::string printActivities(std::list<Activity*>& activities);

    const std::string printStates(State* s);

    const std::string printStateMachine(StateMachine&);

    const std::string formatStatus(std::list<State*>& status, const bool usefullyqualified = false);

    bool compareStateDocOrder(State* s1, State* s2);

    void sortAtomicStates(std::set<State*>& status, std::vector<State*>& sortedStatus);

    bool isInState(const std::list<State*>& status, const std::list<std::string>& stateNames);

    int countParents(State* s);

    bool isDescendant(State* s, State* p);

    std::set<State*> getAncestors(std::list<State*>& states);

    std::set<State*> getAncestors(State* state);

    std::list<State*> getAncestorsList(std::set<State*>& states);

    std::list<State*> getAncestorsList(State*);

    std::list<State*> getAncestorsList(std::list<State*>& states);

    std::list<State*> getProperAncestors(State* state, State* upperBound);

    State* findLeastCommonAncestor(State* s1, State* s2);

    bool eventMatch(const Event& e1, const Event& e2);

    std::list<State*> getAtomicStates(std::set<State*>& states);

    std::list<State*> getAtomicStates(std::list<State*>& states);

    bool isPreempted(State* s, std::list<Transition*>& transitions);
 
    static const std::string LEAF_STATE_SEPARATOR;  // used to separate leaf states
    static const std::string COMP_STATE_SEPARATOR;  // used to build fully qualified state names
 
   private:
    Helper(const Helper&);             
    Helper& operator=(const Helper&);  
};
 
}  // namespace scxml4cpp
 
#endif  // SCXML4CPP_HELPER_H