kappa_sdk.AnalysisResults#

class kappa_sdk.AnalysisResults(xml_string)[source]#

Wrapper for the results.xml from KW document.

Presents analysis results XML in convenient way, supporting both v1 and v2 schemas.

Note

Document.analysis_results property is populated on-demand and is cached for the duration of the Connection.

If you need to get actual values, use the Document.get_results_xml() method and instantiate this class with it.

Methods

`AnalysisResults.get_analysis_names`()	Returns a list of analysis names.
`AnalysisResults.get_parameter_value`(...)	Returns a value of a given parameter.
`AnalysisResults.get_period_names`(analysis_name)	Returns a list of extracted flow period names for a given analysis.
`AnalysisResults.get_period_property_value`(...)	Returns a value for a property of a given period.
`AnalysisResults.get_productivity_index_table_elements`([...])	Returns a dict with the productivity index table elements for each analysis name.