agent_message.hpp

Go to the documentation of this file.

/*
Copyright (c) 2025 acrion innovations GmbH
Authors: Stefan Zipproth, s.zipproth@acrion.ch
 
This file is part of nexuslua, see https://github.com/acrion/nexuslua and https://nexuslua.org
 
nexuslua is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://acrion.ch/sales. For AGPL licensing, see below.
 
AGPL licensing:
 
nexuslua is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
nexuslua 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 Affero General Public License for more details.
 
You should have received a copy of the GNU Affero General Public License
along with nexuslua. If not, see <https://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "lua_table.hpp"
 
#include "nexuslua_export.h"
 
#include <atomic>
#include <memory>
#include <string>
 
namespace nexuslua
{
    class Lua;
 
    enum class AgentType
    {
        Undefined = -1,
        Lua       = 0,
        Cpp       = 1
    };

    class NEXUSLUA_EXPORT AgentMessage
    {
    public:
        AgentType               GetAgentType() const;                                                    
        std::string             GetAgentName() const;                                                    
        std::string             GetMessageName() const;                                                  
        std::string             GetDisplayName() const;                                                  
        std::string             GetDescription() const;                                                  
        LuaTable::nested_tables GetParameterDescriptions() const;                                        
        LuaTable::nested_tables GetDescriptionsOfUnsetParameters(const LuaTable& parameterValues) const; 
        std::string             GetIconPath() const;                                                     
        void                    Send(const LuaTable& parameters) const;                                  
 
    private:
        friend class Agent;
        friend class AgentCpp;
 
        AgentMessage(const int agentN, const AgentType& agentType, const std::string& agentName, const std::string& messageName, const LuaTable::nested_tables& parameterDescriptions, const std::string& displayName, const std::string& description, const std::string& icon);
        AgentMessage(const int agentN, const AgentType& agentType, const std::string& agentName, const std::string& messageName);
 
        int                     _agentN;
        AgentType               _agentType;
        std::string             _agentName;
        std::string             _messageName;
        LuaTable::nested_tables _parameterDescriptions;
        std::string             _displayName;
        std::string             _description;
        std::string             _svgIcon;
        std::shared_ptr<Lua>    _lua;
 
        void     Validate(const LuaTable& parameterValues) const;
        LuaTable AddDefaultParameterValues(const LuaTable& parameterValues) const;
    };
}