RAMSES Documentation  27.0.130
Information for RAMSES users and developers
IRamshCommand.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2021 BMW AG
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_API_IRAMSHCOMMAND_H
10 #define RAMSES_API_IRAMSHCOMMAND_H
11 
13 #include <string>
14 #include <vector>
15 
16 namespace ramses
17 {
25  {
26  public:
30  virtual ~IRamshCommand() = default;
31 
37  virtual const std::string& keyword() const = 0;
38 
44  virtual const std::string& help() const = 0;
45 
58  virtual bool execute(const std::vector<std::string>& input) = 0;
59  };
60 }
61 
62 #endif
#define RAMSES_API
Definition: APIExport.h:35
Class representing a ramses ramsh command.
Definition: IRamshCommand.h:25
virtual ~IRamshCommand()=default
Destructor of IRamshCommand.
virtual bool execute(const std::vector< std::string > &input)=0
The command handler. It will be invoked with all ramsh command tokens.
virtual const std::string & help() const =0
Helptext for this ramsh command. It will be displayed when the user invokes the 'help' command....
virtual const std::string & keyword() const =0
Keyword of this ramsh command. The keyword can be an alphanumeric string. Ramsh inputs having this ke...
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15