StateDescription.hpp

/***************************************************************************
  tag: Peter Soetens  Thu Apr 22 20:40:59 CEST 2004  StateDescription.hpp

                        StateDescription.hpp -  description
                           -------------------
    begin                : Thu April 22 2004
    copyright            : (C) 2004 Peter Soetens
    email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   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 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 STATE_DESCRIPTION_HPP
#define STATE_DESCRIPTION_HPP

#include "StateInterface.hpp"
#include "ProgramInterface.hpp"

namespace RTT
{ namespace scripting {

    class RTT_SCRIPTING_API StateDescription
        : public StateInterface
    {
        ProgramInterfacePtr mentry;
        ProgramInterfacePtr mexit;
        ProgramInterfacePtr mhandle;
        ProgramInterfacePtr mrun;
        std::string name;
        int entrypoint;
        bool inited;
    public:
        StateDescription(const std::string& _name, int linenr )
            : mentry(), mexit(), mhandle(), mrun(),
              name(_name), entrypoint(linenr), inited(false)
        {
        }

        virtual ~StateDescription();

        const std::string& getName() const { return name; }
        void setName(const std::string& newname) { name = newname; }

        void setEntryPoint(int line) { entrypoint = line; }
        int getEntryPoint() const { return entrypoint; }

        StateDescription* postponeState();

        ProgramInterface* getEntryProgram() const {
            return mentry.get();
        }

        ProgramInterface* getRunProgram() const {
            return mrun.get();
        }

        ProgramInterface* getHandleProgram() const {
            return mhandle.get();
        }

        ProgramInterface* getExitProgram() const {
            return mexit.get();
        }

        void setEntryProgram( ProgramInterfacePtr entry ) {
            mentry = entry;
        }

        void setRunProgram( ProgramInterfacePtr run ) {
            mrun = run;
        }

        void setHandleProgram( ProgramInterfacePtr handle ) {
            mhandle = handle;
        }

        void setExitProgram( ProgramInterfacePtr exit ) {
            mexit = exit;
        }

        bool isDefined() const
        {
            return inited;
        }

        void setDefined( bool d ) {
            inited = d;
        }

        StateDescription* copy( std::map<const base::DataSourceBase*, base::DataSourceBase*>& replacementdss ) const;

    };
}};

#endif