Standard

class pyaedt.modules.report_templates.Standard(app, report_category, setup_name, expressions=None)

Provides a reporting class that fits most of the app’s standard reports.

Methods

Standard.add_cartesian_x_marker(val[, name])	Add a cartesian X marker.
Standard.add_cartesian_y_marker(val[, name, ...])	Add a cartesian Y marker.
Standard.add_limit_line_from_equation(...[, ...])	Add a Cartesian limit line from point lists.
Standard.add_limit_line_from_points(x_list, ...)	Add a Cartesian limit line from point lists.
Standard.add_note(text[, x_position, y_position])	Add a note at a position.
Standard.add_trace_to_report(traces[, ...])	Add a trace to a specific report.
Standard.create([plot_name])	Create a report.
Standard.delete()	Delete current report.
Standard.delete_traces(plot_name, traces_list)	Delete an existing trace or traces.
Standard.edit_general_settings([...])	Edit general settings for the plot.
Standard.edit_grid([minor_x, minor_y, ...])	Edit the grid settings for the plot.
Standard.edit_header([company_name, ...])	Edit the plot header.
Standard.edit_legend([show_solution_name, ...])	Edit the plot legend.
Standard.edit_x_axis([font, font_size, ...])	Edit the X-axis settings.
Standard.edit_x_axis_scaling([...])	Edit the X-axis scaling settings.
Standard.edit_y_axis([axis_name, font, ...])	Edit the Y-axis settings.
Standard.edit_y_axis_scaling([axis_name, ...])	Edit the Y-axis scaling settings.
Standard.get_solution_data()	Get the report solution data.
Standard.hide_legend([solution_name, ...])	Hide the Legend.
Standard.import_traces(file_path, plot_name)	Import report data from a file into a specified report.
Standard.update_expressions_with_defaults([...])	Update the list of expressions by taking all quantities from a given category.
Standard.update_trace_in_report(traces[, ...])	Update a trace in a specific report.

Attributes

Standard.differential_pairs	Differential pairs flag.
Standard.domain	Plot domain.
Standard.expressions	Expressions.
Standard.limit_lines	List of available limit lines in the report.
Standard.matrix	2D or Q3D matrix name.
Standard.notes	List of available notes in the report.
Standard.plot_name	Plot name.
Standard.polyline	Polyline name for the field report.
Standard.primary_sweep	Primary sweep report.
Standard.primary_sweep_range	Primary sweep range report.
Standard.pulse_rise_time	Value of Pulse rise time for TDR plot.
Standard.report_category	Report category.
Standard.report_type	Report type.
Standard.secondary_sweep	Secondary sweep report.
Standard.secondary_sweep_range	Secondary sweep range report.
Standard.sub_design_id	Subdesign ID for a Circuit or HFSS 3D Layout subdesign.
Standard.time_start	Time start value.
Standard.time_stop	Time stop value.
Standard.time_windowing	Returns the TDR time windowing. Options are:
Standard.traces	List of available traces in the report.
Standard.use_pulse_in_tdr	Defines if the TDR should use a pulse or step.
Standard.variations	Variations.