TransitionTarget.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 *  and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Redistribution and modification of this code is strictly prohibited.
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_TRANSITIONTARGET_H_
#define _MIRA_TRANSITIONTARGET_H_

#include <string>
#include <list>
#include <map>

#ifndef Q_MOC_RUN
#include <boost/shared_ptr.hpp>
#endif

namespace mira { namespace sm {


class Transition;
class TransitionTarget;

class HistoryState;
typedef boost::shared_ptr<HistoryState> HistoryStatePtr;
typedef std::list<HistoryStatePtr> HistoryStateList;

typedef boost::shared_ptr<TransitionTarget> TransitionTargetPtr;
typedef std::list<TransitionTargetPtr> TransitionTargetList;

typedef boost::shared_ptr<Transition> TransitionPtr;
typedef std::list<TransitionPtr> TransitionList;

class TransitionTarget
{
public:
    TransitionTarget(TransitionTargetPtr p, uint32 sid) :
        parent(p), sortID(sid), firstEntry(true) {}
    virtual ~TransitionTarget() {}

    TransitionTargetPtr parent;
    uint32 sortID;
    std::string id;
    std::vector<XMLDom::iterator> onEntry;
    std::vector<XMLDom::iterator> onExit;
    std::map<std::string, std::string> dataModel;
    TransitionTargetList children;
    HistoryStateList history;
    TransitionTargetList final;
    TransitionTargetPtr initial;
    TransitionList transitions;
    bool firstEntry;
};

struct SortEntryOrder
{
    bool operator() (const TransitionTargetPtr& x, const TransitionTargetPtr& y) const
    {
        return x->sortID < y->sortID;
    }
};

struct SortExitOrder
{
    bool operator() (const TransitionTargetPtr& x, const TransitionTargetPtr& y) const
    {
        return x->sortID > y->sortID;
    }
};

typedef std::set<TransitionTargetPtr, SortEntryOrder> TransitionTargetSet;

class InitialState : public TransitionTarget
{
public:
    InitialState(TransitionTargetPtr p, uint32 sid) :
        TransitionTarget(p, sid) {}
};

typedef boost::shared_ptr<InitialState> InitialStatePtr;

class ParallelState : public TransitionTarget
{
public:
    ParallelState(TransitionTargetPtr p, uint32 sid) :
        TransitionTarget(p, sid) {}
};

typedef boost::shared_ptr<ParallelState> ParallelStatePtr;

class State : public TransitionTarget
{
public:
    State(TransitionTargetPtr p, uint32 sid) :
        TransitionTarget(p, sid) {}
};

typedef boost::shared_ptr<State> StatePtr;

class FinalState : public State
{
public:
    FinalState(TransitionTargetPtr p, uint32 sid) :
        State(p, sid) {}

    std::string doneData;
};

typedef boost::shared_ptr<FinalState> FinalStatePtr;

class HistoryState : public State
{
public:
    HistoryState(TransitionTargetPtr p, uint32 sid) :
        State(p, sid) {}

    std::string historyType;
};


}} // namespace

#endif