|
BeSpiceWaveParserLimitedEdition
|
|
BeSpiceWaveParserLimitedEdition
|
This class defines parser objects. More...
Public Member Functions | |
| def | __init__ |
| def | calculatorEvaluate |
| This function evaluates an expression. More... | |
| def | checkForValidLicense |
| This function allows to verify if the software license is still valid. More... | |
| def | checkIsReturnCode |
| This helper function returns 1 if rc_code_string is a valid return code. More... | |
| def | checkIsValidCurve |
| This helper function returns 1 if the passed argument is a valid curve object. More... | |
| def | checkIsValidSection |
| This helper function returns 1 if the passed argument is a valid data section object. More... | |
| def | findCurves |
| This function looks for the curves matching a search string. More... | |
| def | findGlobalProperty |
| This function retrieves the a global property of a specified type. More... | |
| def | getGlobalProperties |
| This function retrieves the all global properties and returns them in a Python dictionary. More... | |
| def | getSections |
| This function returns a list of all parsed data sections. More... | |
| def | readFile |
| This function parses the file "file_name". More... | |
| def | releaseAll |
| This function frees all allocated data structures. More... | |
| def | releaseAllCurves |
| This function frees and invalidates all internal curve data. More... | |
| def | releaseCalculator |
| This function releases the memory and internal data held by the calculator. More... | |
| def | reloadFile |
| This function reloads the file "file_name". More... | |
| def | setLoggerLevel |
| This function sets the verbose mode to a level from 0 to 6. More... | |
| def | setOption |
| This function sets or unsets parser or export options. More... | |
This class defines parser objects.
Parser objects are singletons. They always point to the same internal object. This class implements functions to read waveform files and access the data sections generated when reading the files.
| def af_py_waveform_parser_limited_edition.parser.calculatorEvaluate | ( | string_expression | ) |
This function evaluates an expression.
It returns an error code, a numeric value or a curve object. The expression is equivalent to the expressions used by the calculator in BeSpice Wave.
| def af_py_waveform_parser_limited_edition.parser.checkForValidLicense | ( | ) |
This function allows to verify if the software license is still valid.
| def af_py_waveform_parser_limited_edition.parser.checkIsReturnCode | ( | rc_code_string | ) |
This helper function returns 1 if rc_code_string is a valid return code.
| def af_py_waveform_parser_limited_edition.parser.checkIsValidCurve | ( | curve_object | ) |
This helper function returns 1 if the passed argument is a valid curve object.
| def af_py_waveform_parser_limited_edition.parser.checkIsValidSection | ( | section_object | ) |
This helper function returns 1 if the passed argument is a valid data section object.
| def af_py_waveform_parser_limited_edition.parser.findCurves | ( | search_string | ) |
This function looks for the curves matching a search string.
It returns a list of curve objetcs.
| def af_py_waveform_parser_limited_edition.parser.findGlobalProperty | ( | property_type | ) |
This function retrieves the a global property of a specified type.
It returns the property's value.
| def af_py_waveform_parser_limited_edition.parser.getGlobalProperties | ( | ) |
This function retrieves the all global properties and returns them in a Python dictionary.
| def af_py_waveform_parser_limited_edition.parser.getSections | ( | ) |
This function returns a list of all parsed data sections.
The data sections are returned as section objects.
| def af_py_waveform_parser_limited_edition.parser.readFile | ( | file_name | ) |
This function parses the file "file_name".
The return code "ok" is returned on success.
| def af_py_waveform_parser_limited_edition.parser.releaseAll | ( | ) |
This function frees all allocated data structures.
| def af_py_waveform_parser_limited_edition.parser.releaseAllCurves | ( | ) |
This function frees and invalidates all internal curve data.
| def af_py_waveform_parser_limited_edition.parser.releaseCalculator | ( | ) |
This function releases the memory and internal data held by the calculator.
| def af_py_waveform_parser_limited_edition.parser.reloadFile | ( | file_name | ) |
This function reloads the file "file_name".
The return code "ok" is returned on success.
| def af_py_waveform_parser_limited_edition.parser.setLoggerLevel | ( | logger_level | ) |
This function sets the verbose mode to a level from 0 to 6.
| def af_py_waveform_parser_limited_edition.parser.setOption | ( | option_type, | |
| option_value | |||
| ) |
This function sets or unsets parser or export options.
1.8.6
