This class describes a message that can be sent via nexuslua send or AgentMessage::Send. More...

#include <agent_message.hpp>

Public Member Functions
AgentType	GetAgentType () const
	return the type of the agent that accepts this message (Lua or C++)
std::string	GetAgentName () const
	return the name of the agent that accepts this message
std::string	GetMessageName () const
	this message name is used by AgentMessage::Send
std::string	GetDisplayName () const
	return a display name of this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)
std::string	GetDescription () const
	return a description of this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)
LuaTable::nested_tables	GetParameterDescriptions () const
	return descriptions for each of the parameters of this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)
LuaTable::nested_tables	GetDescriptionsOfUnsetParameters (const LuaTable &parameterValues) const
	convenience method. Returns only those descriptions of parameters that are not part of the given parameter values (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)
std::string	GetIconPath () const
	return the path to an icon that can be shown in a graphical user interface for this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)
void	Send (const LuaTable &parameters) const
	completes values that are missing in parameters based on GetParameterDescriptions() with their default values and sends the message (named GetMessageName()).

Friends
class	Agent
class	AgentCpp

Detailed Description

This class describes a message that can be sent via nexuslua send or AgentMessage::Send.

An instance of this class can be created via addmessage or nexuslua::agents::AddMessageForCppAgent. Please note that the actual data that is sent is composed of AgentMessage::GetMessageName() along with the cbeam::serialization::serialized_object that is passed to the AgentMessage::Send method.

Member Function Documentation

◆ GetAgentName()

std::string nexuslua::AgentMessage::GetAgentName ( ) const

return the name of the agent that accepts this message

◆ GetAgentType()

AgentType nexuslua::AgentMessage::GetAgentType ( ) const

return the type of the agent that accepts this message (Lua or C++)

◆ GetDescription()

std::string nexuslua::AgentMessage::GetDescription ( ) const

return a description of this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)

◆ GetDescriptionsOfUnsetParameters()

LuaTable::nested_tables nexuslua::AgentMessage::GetDescriptionsOfUnsetParameters ( const LuaTable & parameterValues ) const

convenience method. Returns only those descriptions of parameters that are not part of the given parameter values (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)

◆ GetDisplayName()

std::string nexuslua::AgentMessage::GetDisplayName ( ) const

return a display name of this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)

◆ GetIconPath()

std::string nexuslua::AgentMessage::GetIconPath ( ) const

return the path to an icon that can be shown in a graphical user interface for this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)

◆ GetMessageName()

std::string nexuslua::AgentMessage::GetMessageName ( ) const

this message name is used by AgentMessage::Send

◆ GetParameterDescriptions()

LuaTable::nested_tables nexuslua::AgentMessage::GetParameterDescriptions ( ) const

return descriptions for each of the parameters of this message (may be empty, usually set for agents that are used as plugins, see PluginsOnline::Get)

◆ Send()

void nexuslua::AgentMessage::Send ( const LuaTable & parameters ) const

completes values that are missing in parameters based on GetParameterDescriptions() with their default values and sends the message (named GetMessageName()).

◆ Agent

friend class Agent

friend

◆ AgentCpp

friend class AgentCpp