Result (kind2-java-api 0.3.0 API)

java.lang.Object
- edu.uiowa.cs.clc.kind2.results.Result

```
public class Result
extends java.lang.Object
```
The class is the top one in Kind2 explanations. An instance of this class is generated from kind2 json string using the method analyzeJsonResult(String). The returned instance contains a list of NodeResult which are the results of the sub-components. It also contains a list of Log for the logs generated by kind2. By default the returned instance uses the names in the lustre code, and surround them with {{}}. These opening and closing symbols can be changed using the method setOpeningSymbols(String) and setClosingSymbols(String) respectively.

Constructor Summary

Constructors
Constructor and Description

Result()
a default constructor

Constructors
Constructor and Description
`Result()` a default constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Result`	`analyzeJsonResult(java.lang.String json)` Analyze the json output of kind2 verification.
`java.util.List<Log>`	`getAllKind2Logs()`
`java.util.List<AstInfo>`	`getAstInfos()`
`static java.lang.String`	`getClosingSymbols()`
`java.util.Set<Property>`	`getFalsifiedProperties()`
`java.lang.String`	`getJson()`
`java.util.List<Log>`	`getKind2Logs()`
`NodeResult`	`getNodeResult(java.lang.String nodeName)`
`static java.lang.String`	`getOpeningSymbols()`
`Options`	`getOptions()`
`static int`	`getRealPrecision()`
`static java.math.RoundingMode`	`getRealRoundingMode()`
`java.util.Map<java.lang.String,NodeResult>`	`getResultMap()`
`NodeResult`	`getRoot()`
`double`	`getTimeout()`
`java.util.Set<Property>`	`getUnknownProperties()`
`java.util.Set<Property>`	`getValidProperties()`
`void`	`initialize(java.lang.String json)`
`boolean`	`isInitialized()`
`static boolean`	`isPrintingCounterExamplesEnabled()`
`static boolean`	`isPrintingLineNumbersEnabled()`
`static boolean`	`isPrintingUnknownCounterExamplesEnabled()`
`static void`	`setClosingSymbols(java.lang.String symbols)` Set the opening symbols for printing lustre names
`static void`	`setOpeningSymbols(java.lang.String symbols)` Set the opening symbols for printing lustre names
`static void`	`setPrintingCounterExamplesEnabled(boolean value)` Sets the value of printingCounterExamplesEnabled
`static void`	`setPrintingLineNumbersEnabled(boolean value)` set the value of printingLineNumbersEnabled
`static void`	`setPrintingUnknownCounterExamplesEnabled(boolean value)` Sets the value of printingUnknownCounterExamplesEnabled
`static void`	`setRealPrecision(int realPrecision)` Set the precision for printing real numbers
`static void`	`setRealRoundingMode(java.math.RoundingMode realRoundingMode)` Set the rounding mode for real numbers
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Result
```
public Result()
```
    a default constructor
- Method Detail
  - getNodeResult
```
public NodeResult getNodeResult(java.lang.String nodeName)
```
    Parameters:
    
    nodeName - the name of the node
    
    Returns:
    
    NodeResult which contains the analyses performed by kind2 on the given node.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - analyzeJsonResult
```
public static Result analyzeJsonResult(java.lang.String json)
```
    Analyze the json output of kind2 verification.
    
    Parameters:
    
    json - kind2 json output
    
    Returns:
    
    Result which contains the result of analyzing kind2 output.
  - initialize
```
public void initialize(java.lang.String json)
```
  - getTimeout
```
public double getTimeout()
```
    Returns:
    
    The wallclock timeout used for all the analyses
  - getOptions
```
public Options getOptions()
```
    Returns:
    
    options used by kind2 process.
  - getJson
```
public java.lang.String getJson()
```
    Returns:
    
    Kind2 json output.
  - getRoot
```
public NodeResult getRoot()
```
    Returns:
    
    NodeResult for the top component in kind2 output.
  - getResultMap
```
public java.util.Map<java.lang.String,NodeResult> getResultMap()
```
  - getFalsifiedProperties
```
public java.util.Set<Property> getFalsifiedProperties()
```
    Returns:
    
    a list of Property for all falsified properties including the falsified properties for the subcomponents.
  - getValidProperties
```
public java.util.Set<Property> getValidProperties()
```
    Returns:
    
    a list of Property for all valid properties including the valid properties for the subcomponents.
  - getUnknownProperties
```
public java.util.Set<Property> getUnknownProperties()
```
    Returns:
    
    a list of Property for all unknown properties including the unknown properties for the subcomponents.
  - isPrintingCounterExamplesEnabled
```
public static boolean isPrintingCounterExamplesEnabled()
```
    Returns:
    
    true if printing counter examples for falsifiable properties is enabled.
  - setPrintingCounterExamplesEnabled
```
public static void setPrintingCounterExamplesEnabled(boolean value)
```
    Sets the value of printingCounterExamplesEnabled
    
    Parameters:
    
    value -
  - isPrintingUnknownCounterExamplesEnabled
```
public static boolean isPrintingUnknownCounterExamplesEnabled()
```
    Returns:
    
    a boolean that determines whether to print the last counter examples for unknown properties
  - setPrintingUnknownCounterExamplesEnabled
```
public static void setPrintingUnknownCounterExamplesEnabled(boolean value)
```
    Sets the value of printingUnknownCounterExamplesEnabled
    
    Parameters:
    
    value -
  - isPrintingLineNumbersEnabled
```
public static boolean isPrintingLineNumbersEnabled()
```
    Returns:
    
    a boolean that determines whether line numbers are printed
  - setPrintingLineNumbersEnabled
```
public static void setPrintingLineNumbersEnabled(boolean value)
```
    set the value of printingLineNumbersEnabled
    
    Parameters:
    
    value -
  - setOpeningSymbols
```
public static void setOpeningSymbols(java.lang.String symbols)
```
    Set the opening symbols for printing lustre names
    
    Parameters:
    
    symbols -
  - setClosingSymbols
```
public static void setClosingSymbols(java.lang.String symbols)
```
    Set the opening symbols for printing lustre names
    
    Parameters:
    
    symbols -
  - getRealPrecision
```
public static int getRealPrecision()
```
    Returns:
    
    returns the precision for printing real numbers
  - setRealPrecision
```
public static void setRealPrecision(int realPrecision)
```
    Set the precision for printing real numbers
  - getRealRoundingMode
```
public static java.math.RoundingMode getRealRoundingMode()
```
    Returns:
    
    the rounding mode for real numbers
  - setRealRoundingMode
```
public static void setRealRoundingMode(java.math.RoundingMode realRoundingMode)
```
    Set the rounding mode for real numbers
    
    Parameters:
    
    realRoundingMode - see https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/RoundingMode.html
  - getOpeningSymbols
```
public static java.lang.String getOpeningSymbols()
```
    Returns:
    
    the opening symbols for printing lustre names
  - getClosingSymbols
```
public static java.lang.String getClosingSymbols()
```
    Returns:
    
    the closing symbols for printing lustre names
  - getKind2Logs
```
public java.util.List<Log> getKind2Logs()
```
    Returns:
    
    a list of Log excluding hidden logs.
  - getAstInfos
```
public java.util.List<AstInfo> getAstInfos()
```
    Returns:
    
    a list of AstInfo.
  - getAllKind2Logs
```
public java.util.List<Log> getAllKind2Logs()
```
    Returns:
    
    a list of Log for all kind2 logs.
  - isInitialized
```
public boolean isInitialized()
```
    Returns:
    
    whether or not this object is properly initialized.

Class Result

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Result

Method Detail

getNodeResult

toString

analyzeJsonResult

initialize

getTimeout

getOptions

getJson

getRoot

getResultMap

getFalsifiedProperties

getValidProperties

getUnknownProperties

isPrintingCounterExamplesEnabled

setPrintingCounterExamplesEnabled

isPrintingUnknownCounterExamplesEnabled

setPrintingUnknownCounterExamplesEnabled

isPrintingLineNumbersEnabled

setPrintingLineNumbersEnabled

setOpeningSymbols

setClosingSymbols

getRealPrecision

setRealPrecision

getRealRoundingMode

setRealRoundingMode

getOpeningSymbols

getClosingSymbols

getKind2Logs

getAstInfos

getAllKind2Logs

isInitialized