Horizon
Public Types | Static Public Member Functions | Public Attributes | List of all members
horizon::ToolResponse Class Reference

To signal back to the core what the Tool did, a Tool returns a ToolResponse. More...

#include <tool.hpp>

Public Types

enum class  Result { NOP , END , COMMIT , REVERT }
 

Static Public Member Functions

static ToolResponse end ()
 Use this if you're done. More...
 
static ToolResponse commit ()
 
static ToolResponse revert ()
 
static ToolResponse next (Result res, ToolID t, std::unique_ptr< ToolData > data=nullptr)
 If you want another Tool to be launched you've finished, use this one.
 

Public Attributes

ToolID next_tool
 
std::unique_ptr< ToolDatadata = nullptr
 
Result result = Result::NOP
 

Detailed Description

To signal back to the core what the Tool did, a Tool returns a ToolResponse.

Member Function Documentation

◆ end()

static ToolResponse horizon::ToolResponse::end ( )
inlinestatic

Use this if you're done.

The Core will then delete the active tool and initiate a rebuild.


The documentation for this class was generated from the following files: