Proyecto-Titulo
/
obelisk
3
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity

add action documentation

This commit is contained in:
Chris Cromer 2022-12-10 18:13:01 -03:00
parent d6a7913993
commit 26a861772c
Signed by: cromer
GPG Key ID: FA91071797BEEEC2
1 changed files with 61 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
src/models/action.h
View File

@ -5,43 +5,104 @@
namespace obelisk
{
/**
* @brief The Action model represents an action to take when a fact is true
* or false.
*
*/
class Action
{
private:
/**
* @brief The ID of the action in the knowledge base.
*
*/
int id_;
/**
* @brief The name of the action.
*
*/
std::string name_;
public:
/**
* @brief Construct a new Action object.
*
*/
Action() :
id_(0),
name_("")
{
}
/**
* @brief Construct a new Action object.
*
* @param[in] id The ID of the action.
*/
Action(int id) :
id_(id),
name_("")
{
}
/**
* @brief Construct a new Action object.
*
* @param[in] name The name of the action.
*/
Action(std::string name) :
id_(0),
name_(name)
{
}
/**
* @brief Construct a new Action object.
*
* @param[in] id The ID of the action.
* @param[in] name The name of the action.
*/
Action(int id, std::string name) :
id_(id),
name_(name)
{
}
/**
* @brief Create the action table in the knowledge base.
*
* @return const char* Returns the query used to create the table.
*/
static const char* createTable();
/**
* @brief Get the ID of the action.
*
* @return int& Returns the ID.
*/
int& getId();
/**
* @brief Set the ID of the action.
*
* @param[in] id Set the ID of the action.
*/
void setId(int id);
/**
* @brief Get the name of the action.
*
* @return std::string& The action name.
*/
std::string& getName();
/**
* @brief Set the name of the action.
*
* @param[in] name The name of the action.
*/
void setName(std::string name);
};
} // namespace obelisk