Command Line User Guide

Syntax

Safety Analysis offers command-line interface for its most basic features. If you are looking for instructions how to enter these arguments in IDE go here.

In case you dont enter any arguments, will be displayed GNU HELP with all available arguments.

The config file is a simple text file and should contain one command-line option (omitting the dashes) per line in the format:

 -flag value

or for a option without value:

 -flag

Example

 pl.wroc.pwr.sa.gui.cli.MainCLI -e "tree.xml" -c

This example command imports Event Tree from XML file and checks the cohesion. Detailed information about arguments in the next section.

Short list of arguments (GNU HELP)

usage: SafetyAnalysis [-n eventname] [-p] [-a] [-r file] [-c] [-s scenario] [-e file] [-f file] [-i]

-a,--analyseFaultTree	Analyse fault tree and show results
-c,--checkTheCohesionOfTheEventTree	Analyse The Cohesion Of The Event Tree
-e,--eventtree <file>	Read Event Tree from file (relative path, e.g. -e "safety-gui/newXml5.xml"
-f,--faulttree <file>	Read Fault Tree from file (relative path)
-i,--getFuzzyImportanceIndex	Get Fuzzy Importance Index of Faut Tree
-n,--evntnme <eventname>	Get event name
-p,--importanceAnalise	Execute importance analisis
-r,--report <file>	Generate report with given date, logo and title paragraph
-s, --evtsce <scenario>	Counts probability for scenarios in Events Tree

Detailed list of arguments

Event Tree related arguments

usage: pl.wroc.pwr.sa.gui.cli.MainCLI -e PATHTOFILE [options]

eventtree <file>
Flag	-e
Parametr	String: path (path to XML file to be loaded)
Description	Read Event Tree from file
Output: success	"Read Event Tree file from: " + path + " Success"
Output: fail	"Read Event Tree file from: " + path + " Fail"

checkTheCohesionOfTheEventTree
Flag	-c
Parametr	-
Description	Check The Cohesion Of The Event Tree
Output: success	"Result of the analysis Events Tree: " "Events tree is ok"
Output: fail	"There is no tree that I could analyze."

Detailed description
Method checks the cohesion of the tree. For each leaf of the tree method checks further parents. When last of the parents is different from root (InitialBranch), exception is thrown.
Tip: This method operates on edges.

evtsce <scenario>
Flag	-s
Parametr	String: option (comma separated scenario indexes)
Description	Count probability for scenarios
Output: success	"Membership Function for scenarioo: [" + option + "]" ...
Output: fail	"There is no tree"

Detailed description

Trapezoidal fuzzy numbers are reprezents by 4 parameters <a, b, c, d>

The function multiplies the parameters of trapezoidal-shaped membership functions of the edges from the specific edge to the root (not including the root) to calculate the probability of the scenario (approximate result).

The function uses this pattern to sum up the probabilities of scenarios:

eventTreeScenarioCounter

This is description of MainCLI function(eventTreeScenarioCounter(String)). 
In Step2 we started to describe MainAPI function(eventTreeScenarioCounter(String, EventTree)) after MainCLI function constructs 'MembershipFunction' object.
In Step3 we are back to MainCLI function(eventTreeScenarioCounter(String)).


Step1: The function initializes empty string (e.g. 'outputText').
Step2: The function constructs the 'MembershipFunction' object (e.g. 'mf1') equal api.eventTreeScenarioCounter (argument of described function (e.g. 'option'), eventsTree). 
'option' is a string with the scenarios indexes separated by commas. 
eventTreeScenarioCounter converts separeted scenarios indexes into an integer and assigns it to the new table (e.g. indexes). 
eventTreeScenarioCounter constructs the 'MembershipFunction' object (e.g. 'mf2') equal null.
If (eventsTree == null) eventTreeScenarioCounter returns null
Else{
If (size of 'indexes' == 1) eventTreeScenarioCounter counts the probability of scenario from 'option' and assign it to the 'mf2'.
Else if (size of 'indexes' > 1){
eventTreeScenarioCounter constructs list of 'MembershipFunction' elements (e.g. 'probab').
eventTreeScenarioCounter counts the probabilities of the scenarios from 'option' and assigns it to the 'probab'.
eventTreeScenarioCounter constructs the 'MembershipFunction' object (e.g. 'mf3') equal sumMembershipFunctionsOfScenarios(probab) to sums up the propabilities from the list and assigns it to the 'mf2'.
}
eventTreeScenarioCounter returns 'mf2'.
Step3: If ('mf1' == null) The function assigns "There is no tree" to the 'outputText' and then display it.
Else {
The function constructs the 'ParamTrapezoid' object (e.g. 'pt'), then gets parametrs from 'mf1' and assigns it to the 'pt'.
The function assigns "\nMembership Function for scenario/scenarios: [" + 'option' + "]" plus 4 parameters(taken from 'pt') separeted by "\n" to the 'outputText' and then display it.
}

importanceAnalise
Flag	-p
Parametr	String: name (name of event)
Description	Check importance analisis
Output: success	"Result of the analysis Events Tree: "
Output: success	If exception will be catch (during the analysis): "Events tree is not ok"
Output: fail	"There is no tree that I could analyze."

Detailed description

This function check probability before and after cut an event which was passed as parameter. The probability of scenario is calculated by formula

P(x₁,...,X_n) - probability of scenario

P(X₁),P(X_n) - probability of events which led to that scenario

If to that function we will pass name of Event 2, function will cut Failure(2f) and all its sub trees then it will calculate probability of scenario without excluded part and print it with information about probability of primary tree(before cut was done).

Event Tree analysis concept

It is worth to mention that probability of success of event and probability of failure of that event must sum to 1.

Also probability of scenario is not equal to intensity of scenario occurrence. In intensity of scenario occurrence (intensity of specific scenario e.g. Failure scenario D) we take also intensity of initiating event occurrence (I_IE) but in probability of scenario we start form first event. (Event 1)

Importance Analise

Step1: The function initializes empty string (e.g. 'outputText') and (e.g. 'a').
Step2: If eventTree !=null create object of TreesService class and set boolean (e.g. 'ok') to true. After that start analyse of event tree using function doAnalise.
doAnalise function is checking the probability before and after the removingEdge. At first it compute probability of basic tree, it is done by computing probability of each scenario associated with leaf. It is calculated in 'computeProbabolityForLeaf' function, probability of leaf is assigned to 'tmpProbability' variable and probability of its parent to 'edge' variable then multiply of leaf and theirs parent probability is assigned to 'tmpProbabolity'. This process is executed up to Event 1. At last in 'computeProbabilityForLeaf' it's sums probability of scenarios which led to that consequence and return them to 'importanceAnalisis' function which pass them to 'doAnalise' function.
After that 'doAnalise' removes edgeList which we passed to 'importanceAnalise' and one more time it runs 'doAnalise' function for tree in which we removed some edges.
At end of 'doAnalise' it return string "Prawdopodobieństwa przed: " + oldProbability + "\nPrawdopodobieństwa po: " + newProbability" which is also output of 'importanceAnalise' function.
Step3: If eventTree = null The function assign "There is no tree" to the 'outputText' and then display it.

Fault Tree related arguments

usage: pl.wroc.pwr.sa.gui.cli.MainCLI -e PATHTOFILE [options]

faulttree <file>
Flag	-f
Parametr	String: path (path to XML file to be loaded)
Description	Read Fault Tree from file
Output: success	"Read Fault Tree file from: " + path + " Success"
Output: fail	"Read Fault Tree file from: " + path + " Fail"

analyseFaultTree
Flag	-a
Parametr	-
Description	Analyse fault tree and show results
Output: success	"Result of the analysis Fault Tree: " "Key: " + key + " = Value: " + value
Output: fail	"There is no tree that I could analyze."

getFuzzyImportanceIndex
Flag	-i
Parametr	-
Description	Get Fuzzy Importance Index of Faut Tree
Output: success	"Key: " + key.getName() + " = Value: " + value.getName()"
Output: fail	"There is no tree that I could analyze"

Others
report <file>
Flag -r
Parametr
String: path (where raport will be saved)
Description
Generate report with given date, logo and title paragraph
Output: success
"Created file: "
Output: fail
-
- Examples of reports
  Empty report
  usage: -r raportTest.doc
  Report with loaded event tree
  usage: -e safety-gui/newXml5.xml -r raportTest.doc
  
  Report with loaded event tree and checked cohesion
  usage: -e safety-gui/newXml5.xml -c -r raportTest.doc
  Report with loaded and analysed FaultTree
  usage: -f safety-gui/exampleFaultTree.xml -a -r raportTest.doc
  Report with loaded FaultTree and Fuzzy Importance Result
  usage: -f safety-gui/exampleFaultTree.xml -i -r raportTest.doc
evntnme <eventname>
Flag -n
Parametr
String name
Description
Get event name.
This is used when importance analysis is started (-p)
Output: success -

Output: fail
-

CLI Documentation

.

Browser not supported