gmslAPI  0.1
gmslAPI: An API for Developing Upgrade Solutions using Great Migrations Technology
gmslAPI.ScriptRules Class Reference

Public Member Functions

 ScriptRules (string DefaultRulesFilePath=@"..\r\riptRules.xml")
 Initializes the ScriptRules object and sets the default file path containing ScriptRules XML More...
 
string AllRulesReport ()
 
void AddRules (gmStudioTask task, string ruleName, string ruleFilePath="")
 Add rules to the rules collection if they apply to the task More...
 

Public Attributes

const string gmplEndTag = "gmPL"
 
bool logEnable
 
bool addStrict
 

Properties

StringBuilder OptionRulesBuffer [get]
 
StringBuilder CompileRulesBuffer [get]
 
StringBuilder PreAnalyseRulesBuffer [get]
 
StringBuilder AnalyseRulesBuffer [get]
 
StringBuilder PostAnalyseRulesBuffer [get]
 
StringBuilder AuthorRulesBuffer [get]
 
StringBuilder PostAuthorRulesBuffer [get]
 
int OptionRules [get]
 
int CompileRules [get]
 
int PreAnalyseRules [get]
 
int AnalyseRules [get]
 
int PostAnalyseRules [get]
 
int AuthorRules [get]
 
int PostAuthorRules [get]
 

Constructor & Destructor Documentation

◆ ScriptRules()

gmslAPI.ScriptRules.ScriptRules ( string  DefaultRulesFilePath = @"..\usr\ScriptRules.xml")

Initializes the ScriptRules object and sets the default file path containing ScriptRules XML

Parameters
DefaultRulesFilePath

Member Function Documentation

◆ AddRules()

void gmslAPI.ScriptRules.AddRules ( gmStudioTask  task,
string  ruleName,
string  ruleFilePath = "" 
)

Add rules to the rules collection if they apply to the task

Parameters
tasktask data used for selecting conditional rules
ruleNamename of rule to add
ruleFilePathpath to file containing rule

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