Version: 1.0
Public Member Functions | List of all members
BaseRuleSet Class Referenceabstract

Is the base class for the RuleSet from which every user-defined RuleSet should inherit. More...

#include <base_ruleset.h>

Public Member Functions

 BaseRuleSet (bool force_generation=false)
 
 BaseRuleSet (std::filesystem::path custom_path)
 
rule_set GetRuleSet ()
 
virtual rule_set GenerateRuleSet ()=0
 

Detailed Description

Is the base class for the RuleSet from which every user-defined RuleSet should inherit.

It contains member functions (LoadRuleSet and SaveRuleSet) to load and store a .yaml file which define the RuleSet.

Definition at line 26 of file base_ruleset.h.

Constructor & Destructor Documentation

◆ BaseRuleSet() [1/2]

BaseRuleSet::BaseRuleSet ( bool  force_generation = false)
inline

Definition at line 64 of file base_ruleset.h.

◆ BaseRuleSet() [2/2]

BaseRuleSet::BaseRuleSet ( std::filesystem::path  custom_path)
inline

Definition at line 69 of file base_ruleset.h.

Member Function Documentation

◆ GenerateRuleSet()

virtual rule_set BaseRuleSet::GenerateRuleSet ( )
pure virtual

◆ GetRuleSet()

rule_set BaseRuleSet::GetRuleSet ( )
inline

Definition at line 73 of file base_ruleset.h.


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