Curves and sections can have properties.
There are generic properties defined by their name and properties defined by their type.
Properties are also used to define parser and data plugin options.
Boolean values are identical to integer value where authorized values are 1 and 0.
| Enumerator |
|---|
| af_wp_prop_invalid |
The property is invalid.
|
| af_wp_prop_string |
Defines a generic property defined by it's name. The value is given as string.
|
| af_wp_prop_integer |
Defines a generic property defined by it's name. The value is given as integer.
|
| af_wp_prop_double |
Defines a generic property defined by it's name. The value is given as double.
|
| af_wp_prop_complex |
Defines a generic property defined by it's name. The value is given as complex.
|
| af_wp_prop_file_name |
The property defines a file name. The value is given as string.
|
| af_wp_prop_file_id |
The property defines an integer identifier. This identifier is unique for a given file name.
|
| af_wp_prop_file_type |
The property defines a file type. The value is given as string.
|
| af_wp_prop_file_variant |
The property defines a variant of a file type. The value is given as string.
|
| af_wp_prop_file_data_base_access |
The property indicates if the file can be accessed like a data base. The value is given as boolean value.
|
| af_wp_prop_file_number_of_sections |
The property indicates how many data sections are available. The value is given as integer value.
|
| af_wp_prop_file_changed |
The property indicates that a file changed. The value is given as boolean value.
|
| af_wp_prop_file_closed |
The property indicates that a file was closed. The value is given as boolean value.
|
| af_wp_prop_global_export_file_name |
The property defines the name of the file that created while exporting. The value is given as string.
|
| af_wp_prop_global_number_of_types |
The property indicates how many types are available. The value is given as integer value.
|
| af_wp_prop_global_log_file_name |
If this property is set debug messages will be printed to the specified file. The value is given as string.
|
| af_wp_prop_global_current_working_directory |
This property makes sure, that relative paths are found correctly. The value is given as string.
|
| af_wp_prop_global_release_date |
This property holds the date when the current version of the library was built. The date is returned as an integer such as 170823 for the 23rd of August 2017.
|
| af_wp_prop_global_release_version |
This property holds the current version of the library as string. In addition to the build date it has some additional information that allows to precisely identify the version.
|
| af_wp_prop_global_expiry_date |
This property holds the date when builtin license for the current library expires. The date is returned as an integer such as 170823 for the 23rd of August 2017.
|
| af_wp_prop_global_license_file_expiry_date |
This property holds the date when license file for the current library expires. The date is returned as an integer such as 170823 for the 23rd of August 2017.
|
| af_wp_prop_global_license_server_expiry_date |
This property holds the date when license server for the current library expires. The date is returned as an integer such as 170823 for the 23rd of August 2017.
|
| af_wp_prop_global_license_server_connection |
This property holds the connection information for the license server as a string.
|
| af_wp_prop_global_license_server_error_messages |
This property holds debug information on license server as a string.
|
| af_wp_prop_global_number_of_curves_that_can_be_released |
This property returns how many curves would be concerned by a af_wp_release_all_curves_and_iterators() call. This excludes curves that are not loaded on demand (for example CSV and VCD files).
|
| af_wp_prop_global_amount_of_curve_memory_that_can_be_released |
This property returns how much memory would be released by a af_wp_release_all_curves_and_iterators() call. This excludes curves that are not loaded on demand (for example CSV and VCD files).
|
| af_wp_prop_section_name |
The property defines a section name. The value is given as string.
|
| af_wp_prop_section_analysis_type |
The property gives a section's analysis type. The value is given as string.
|
| af_wp_prop_section_run_index |
The property gives a section's run index. The value is given as integer.
|
| af_wp_prop_section_string_run_parameter |
The property gives a section's run parameter. The value is given as string. The run parameter might also have a name.
|
| af_wp_prop_section_integer_run_parameter |
The property gives a section's run parameter. The value is given as integer. The run parameter might also have a name.
|
| af_wp_prop_section_double_run_parameter |
The property gives a section's run parameter. The value is given as double value. The run parameter might also have a name.
|
| af_wp_prop_section_complex_run_parameter |
The property gives a section's run parameter. The value is given as complex value. The run parameter might also have a name.
|
| af_wp_prop_section_x_start |
The property gives a section's first x-axis value. The value is given as double value.
|
| af_wp_prop_section_x_step |
The property gives a section's x-axis value step. The value is given as double value.
|
| af_wp_prop_section_x_stop |
The property gives a section's last x-axis value. The value is given as double value.
|
| af_wp_prop_section_x_axis_unit |
The property gives a section's last x-axis unit. The value is given as af_wp_unit_type casted to an integer value or as string value.
|
| af_wp_prop_section_number_of_sweep_variables |
The property gives the number of sweep variables in the section. The value is given as integer.
|
| af_wp_prop_section_total_number_of_variables |
The property gives the total number of variables in the section. The value is given as integer.
|
| af_wp_prop_section_changed |
The property indicates if a section changed. The value is given as boolean value.
|
| af_wp_prop_section_alter_index |
The property gives a section's alter index. The value is given as integer.
|
| af_wp_prop_section_identifier |
The property defines a section's unique identifier. The value determined by the waveform parser. It is given as integer.
|
| af_wp_prop_section_number_of_instances |
The property gives the number of hierarchical instances in the section. The value is given as integer.
|
| af_wp_prop_section_flag_used_for_link |
The property informs if the section is used for linking curves for example to a schematic viewer. The value is given as integer.
|
| af_wp_prop_section_parent_section_id |
The property informs if the section has a parent section. This parent relation can be defined in a logFile. The value is given as integer.
|
| af_wp_prop_section_similar_section_identifier |
The property informs if the section has a similar section. The section_id of this section is returned as integer.
|
| af_wp_prop_variable_name |
The property defines a curve name. The value is given as string.
|
| af_wp_prop_variable_x_axis_unit |
The property gives a curve's last x-axis unit. The value is given as af_wp_unit_type casted to an integer value or as string value.
|
| af_wp_prop_variable_y_axis_unit |
The property gives a curve's last y-axis unit. The value is given as af_wp_unit_type casted to an integer value or as string value.
|
| af_wp_prop_variable_sweep_variable |
The property indicates if a curve is a sweep variable. The value is given as boolean value.
|
| af_wp_prop_variable_data_type |
The property gives a curve's data type. The value is given as af_wp_data_type casted to an integer value.
|
| af_wp_prop_variable_number_of_values |
The property gives the number of values for a curves The value is given as integer.
|
| af_wp_prop_variable_changed |
The property indicates if a curve changed. The value is given as boolean value.
|
| af_wp_prop_variable_string_data_size |
If the curve has a string data type with a constant string length, this property indicates this length.
|
| af_wp_prop_variable_scale |
If a scaling factor applies to the curve's data, this property indicates this factor. It is given as double value.
|
| af_wp_prop_variable_plot_color |
If the curve should be plotted using a particular color, this property indicates this color. It is given as string value.
|
| af_wp_prop_variable_plot_line_style |
If the curve should be plotted using a particular line style, this property indicates this line style. It is given as string value.
|
| af_wp_prop_variable_plot_symbol |
If the curve should be plotted using a particular symbol, this property indicates this symbol. It is given as string value.
|
| af_wp_prop_variable_plot_line_width |
If the curve should be plotted using a particular line width, this property indicates it. It is given as integer value.
|
| af_wp_prop_variable_min_x_value |
This property gives the curve's minimum x-axis value. It is only available after having been computed. It is given as double value.
|
| af_wp_prop_variable_max_x_value |
This property gives the curve's maximum x-axis value. It is only available after having been computed. It is given as double value.
|
| af_wp_prop_variable_real_min_y_value |
This property gives the curve's minimum y-axis value. It is only available after having been computed. It is given as double value.
|
| af_wp_prop_variable_real_max_y_value |
This property gives the curve's maximum y-axis value. It is only available after having been computed. It is given as double value.
|
| af_wp_prop_variable_imag_min_y_value |
This property gives the curve's minimum imaginary y-axis value. It is only available form complex curves after having been computed. It is given as double value.
|
| af_wp_prop_variable_imag_max_y_value |
This property gives the curve's maximum imaginary y-axis value. It is only available form complex curves after having been computed. It is given as double value.
|
| af_wp_prop_variable_x_axis_type_index |
The property gives a curve's x-axis type index. This index is an integer. It can be used to retrieve information about the used type. This property is only given for parameterized curves.
|
| af_wp_prop_variable_y_axis_type_index |
The property gives a curve's y-axis type index. This index is an integer. It can be used to retrieve information about the used type.
|
| af_wp_prop_variable_model |
The property gives a curve's model. The value is given as string. This property is mainly used for operating point analysis results. Example : "model = resistor".
|
| af_wp_prop_variable_region |
The property gives a curve's region. The value is given as string. This property is mainly used for operating point analysis results. Example : "region = saturation" or "region = linear".
|
| af_wp_prop_variable_assert |
The property gives a curve's assert. The value is given as string. This property is mainly used for safe operating area results.
|
| af_wp_prop_variable_instance |
The property gives a curve's instance. The value is given as string. This property is mainly used for safe operating area results.
|
| af_wp_prop_variable_expression |
The property gives a curve's expression. The value is given as string. This property is mainly used for safe operating area results.
|
| af_wp_prop_variable_severity |
The property gives a curve's severity. The value is given as string. This property is mainly used for safe operating area results. Example : "severity = warning".
|
| af_wp_prop_variable_status |
The property gives a curve's status. The value is given as string. This property is mainly used for safe operating area results. Example : "status = failed".
|
| af_wp_prop_variable_vcd_type |
Type of variable as defined in a vcd file.
|
| af_wp_prop_variable_hierachical_instance_index |
The property gives a curve's hierarchical instance index as integer.
|
| af_wp_prop_variable_left_bit_number |
The property defines the left bit number of a vector as integer.
|
| af_wp_prop_variable_right_bit_number |
The property defines the right bit number of a vector as integer.
|
| af_wp_prop_variable_derived_from_curve_index |
The property defines another curve index as integer. This curve's values are defined as a function of the other's values.
|
| af_wp_prop_variable_derived_from_curve_function |
This property defines the derivation function as integer. Therefor the enum type af_wp_derivation_function_type is cated into an interger value.
|
| af_wp_prop_variable_equivalent_parent_net_name |
This property is added if the corresponding curve has been created with af_wp_create_equivalent_nets().
|
| af_wp_prop_variable_equivalent_net_name |
This property is added if the corresponding curve also might be referred to by another name during simulation.
|
| af_wp_prop_calculator_expression_string |
If a curve was generated by the calculator, this property holds the evaluated expression as a string.
|
| af_wp_prop_instance_name |
This property gives the name of an instances. It is given as string value.
|
| af_wp_prop_instance_full_hierarchical_name |
This property gives full hierarchical the name of an instances. It is given as string value.
|
| af_wp_prop_instance_number_of_sub_instances |
This property gives the number of sub-instances defined in a given instance. It is given as integer value.
|
| af_wp_prop_instance_number_of_variables |
This property gives the number of variables defined in a given instance. It is given as integer value.
|
| af_wp_prop_instance_hierarchical_level |
This property gives the hierarchical level of an instances. It is given as integer value.
|
| af_wp_prop_instance_parent_instance_index |
This property gives the index of the parent instance of an instances. It is given as integer value.
|
| af_wp_prop_instance_component_curve_index |
This property gives the index of the curve that is expanded in this instance. This requires the "af_wp_prop_parser_option_create_instance_for_expanded_curves" option.
|
| af_wp_prop_instance_vcd_type |
This property gives the type of an instances. It is given as string value.
|
| af_wp_prop_instance_separator |
This property gives the separator used in the name of a sub-instances or hierarchical curve names. It is given as string value.
|
| af_wp_prop_instance_subcircuit_name |
This property gives the name of the subcircuit in the spice simulation. This property might not be informed.
|
| af_wp_prop_type_data_type |
This property gives the data type of a variable type. The value is given as af_wp_data_type casted to an integer value.
|
| af_wp_prop_type_unit |
The property gives a type's unit. The value is given as af_wp_unit_type casted to an integer value or as string value.
|
| af_wp_prop_type_number_of_sub_types |
This property gives the number of subtypes defined for a given type. It is given as integer value. The value is different from zero only for af_wp_data_scalar_struct and af_wp_data_vector_struct types.
|
| af_wp_prop_type_description |
This property defines a description for the type. In general it is only used for the fields of a structured type.
|
| af_wp_prop_type_name |
This property gives the name of a type. For structured data type it is the field name.
|
| af_wp_prop_type_enumerated_value |
This property gives the string values defined for an enumerated data type. The property field m_integer_value holds the integer value corresponding to the enumerated value. This property also exists for some logic types.
|
| af_wp_prop_type_string_data_size |
If the type defines a string data type with a constant string length, this property indicates this length.
|
| af_wp_prop_parser_option_generate_sweep_variable |
Use this property to generate a sweep variable even if it is not available in the parsed file. The value is given as boolean value.
|
| af_wp_prop_parser_option_convert_int_to_real |
Use this property to generate real variables instead of integer variables. The value is given as boolean value.
|
| af_wp_prop_parser_option_generate_instance_hierarchy |
Use this property to make sure that the hierarchy of subcircuit instances is computed.
|
| af_wp_prop_parser_option_parse_referenced_files |
If this property is set files referenced for example in a "logFile" are parsed automatically.
|
| af_wp_prop_parser_option_release_curve_after_iterator_release |
If this property is set, the memory deallocation is simplified. Curves do no longer have to be released after an iterator has been released.
|
| af_wp_prop_parser_option_generate_expanded_curves |
If this property is set, all curves based on bus types and structured types are also available as individual curves. This only applies to curves with sweep variable.
|
| af_wp_prop_parser_option_generate_expanded_scalar_curves |
If this property is set, all curves based on structured types are also available as individual curves. This only applies to dc, op and soa analysis results and logfiles.
|
| af_wp_prop_parser_option_generate_expanded_logic_bus_curves |
If this property is set, all curves based on logic bus types are also available as individual curves for each bit.
|
| af_wp_prop_parser_option_create_instance_for_expanded_curves |
If this property is set, an instance is created for all curves based on bus types and structured types that are expanded.
|
| af_wp_prop_parser_option_logic_level_0 |
This property defines the real value attributed to logic 0 levels when the curve is transformed to a real-valued curve.
|
| af_wp_prop_parser_option_logic_level_1 |
This property defines the real value attributed to logic 1 levels when the curve is transformed to a real-valued curve.
|
| af_wp_prop_parser_option_logic_level_X |
This property defines the real value attributed to logic X levels when the curve is transformed to a real-valued curve.
|
| af_wp_prop_parser_option_logic_level_Z |
This property defines the real value attributed to logic Z levels when the curve is transformed to a real-valued curve.
|
| af_wp_prop_parser_option_logic_level_U |
This property defines the real value attributed to logic U levels when the curve is transformed to a real-valued curve.
|
| af_wp_prop_parser_option_logic_rise_fall_time |
This property defines the rise and fall time used when a logic curve is transformed to a real-valued curve. This value is also used for enumerated curves.
|
| af_wp_prop_parser_option_enumerated_level |
This property defines the real value attributed to the enumerated curve value defined in m_string_value when the curve is transformed to a real-valued curve. The real attribute must be given in m_real_value.
|
| af_wp_prop_parser_option_create_all_section_properties |
If this option is set, all parsed section properties are available over the interface.
|
| af_wp_prop_parser_option_minimum_size_for_db_access |
If this > 0, smaller variables will be loaded immediately into memory. This isn't supported for all parsers.
|
| af_wp_prop_parser_option_read_all_properties |
If this 1, additional properties (metadata) will be read when parsing a file.
|
| af_wp_prop_parser_option_dont_read_data |
If this 1, data will not be read when parsing a file. This isn't supported by all file types.
|
| af_wp_prop_parser_option_simplify_instance_names_for_currents |
Some simulators add the device type "v" or "c" to the curve names for current measuremants. As a consequence the curve names are incompatible with voltages. If this option is set, the device type is removed from the curve name.
|
| af_wp_prop_parser_option_check_x_axis_values_for_multiple_runs |
Some file types might hold multiple simulation runs. Thererfore the data can stored in a single file or file section. This automatically detected. This option allows to disable the detection. This option can be set to 0, 1 and 2. For the value of 2, the defaults are applied.
|
| af_wp_prop_parser_option_first_x_axis_value |
Some file types can be read only partially on an x-axis interval. Therefore the first and the last x-axis values must be defined.
|
| af_wp_prop_parser_option_last_x_axis_value |
Some file types can be read only partially on an x-axis interval. Therefore the first and the last x-axis values must be defined.
|
| af_wp_prop_parser_option_parse_hidden_curves |
Some file formats define curves that aren't of much interest for most applications. If this property is set these curves are read as well. The default value is false.
|
| af_wp_prop_parser_options_compute_similar_sections |
If this option is set, af_wp_prop_section_similar_section_identifier will be computed for all parsed data sections. The default value is false. The similar sections have identical ordinary variable names. The sweep variables names, the variable data types and section properties might be different.
|
| af_wp_prop_parser_options_compute_similar_sections_check_data_types |
If this option is set, af_wp_prop_section_similar_section_identifier will be computed for all parsed data sections. The default value is false. The similar sections have identical ordinary variable names, sweep variables names and data types. The section properties might be different.
|
| af_wp_prop_parser_option_concatenate_complex_variables |
If this option is set, 2 real variables holding the real and imaginary parts are concatenated to a complex variable. This option can be set to 0, 1 and 2. For the value of 2, the defaults are applied.
|
| af_wp_prop_parser_option_spice_read_included_files |
If set to 1, the function af_wp_create_equivalent_nets() read all files included by the spice netlist. The default is 1.
|
| af_wp_prop_plugin_name |
The property defines a plugin name. The value is given as string.
|
| af_wp_prop_plugin_handled_extension |
The property defines the extensions handled by a plugin. The value is given as string. A plugin can handle several extensions.
|
1.8.6
