action.h

Go to the documentation of this file.

/*
        Scalable Building Simulator - Action Interface Class
        The Skyscraper Project - Version 2.0
        Copyright (C)2004-2024 Ryan Thoryk
        https://www.skyscrapersim.net
        https://sourceforge.net/projects/skyscraper/
        Contact - ryan@skyscrapersim.net
 
        This program 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; either version 2
        of the License, or (at your option) any later version.
 
        This program 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 General Public License for more details.
 
        You should have received a copy of the GNU General Public License
        along with this program; if not, write to the Free Software
        Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#ifndef _SBS_ACTION_H
#define _SBS_ACTION_H
 
namespace SBS {
 
class SBSIMPEXP Action : public ObjectBase
{
public:
        //functions
        Action(Object *parent, const std::string &name, std::vector<Object*> &action_parents, const std::string &command, const std::vector<std::string> &parameters);
        Action(Object *parent, const std::string &name, std::vector<Object*> &action_parents, const std::string &command);
        ~Action();
        bool DoAction(Object *caller, bool &hold);
        std::string GetCommandName();
        const Object *GetParent(int number);
        std::string GetParentName(int number);
        std::string GetParentType(int number);
        int GetParentCount();
        int GetParameterCount();
        std::string GetParameter(int index);
        bool AddParent(Object *parent);
        bool RemoveParent(Object *parent);
 
private:
 
        bool Run(Object *caller, Object *parent, bool &hold);
 
        std::string command_name;
        std::vector<std::string> command_parameters;
        std::vector<Object*> parent_objects;
};
 
}
 
#endif