AntennaParameters

class ansys.aedt.core.visualization.report.field.AntennaParameters(app, report_category, setup_name, far_field_sphere=None, expressions=None)

Provides a reporting class that fits antenna parameter reports in an HFSS plot.

Methods

AntennaParameters.add_cartesian_x_marker(value)	Add a cartesian X marker.
AntennaParameters.add_cartesian_y_marker(value)	Add a cartesian Y marker.
AntennaParameters.add_limit_line_from_equation(...)	Add a Cartesian limit line from point lists.
AntennaParameters.add_limit_line_from_points(...)	Add a Cartesian limit line from point lists.
AntennaParameters.add_note(text[, ...])	Add a note at a position.
AntennaParameters.add_trace_to_report(traces)	Add a trace to a specific report.
AntennaParameters.apply_report_template(...)	Apply report template.
AntennaParameters.create([name])	Create a report.
AntennaParameters.delete()	Delete current report.
AntennaParameters.delete_traces(plot_name, ...)	Delete an existing trace or traces.
AntennaParameters.edit_general_settings([...])	Edit general settings for the plot.
AntennaParameters.edit_grid([minor_x, ...])	Edit the grid settings for the plot.
AntennaParameters.edit_header([...])	Edit the plot header.
AntennaParameters.edit_legend([...])	Edit the plot legend.
AntennaParameters.edit_x_axis([font, ...])	Edit the X-axis settings.
AntennaParameters.edit_x_axis_scaling([...])	Edit the X-axis scaling settings.
AntennaParameters.edit_y_axis([name, font, ...])	Edit the Y-axis settings.
AntennaParameters.edit_y_axis_scaling([...])	Edit the Y-axis scaling settings.
AntennaParameters.export_config(output_file)	Generate a configuration file from active report.
AntennaParameters.get_solution_data()	Get the report solution data.
AntennaParameters.hide_legend([...])	Hide the Legend.
AntennaParameters.import_traces(input_file, ...)	Import report data from a file into a specified report.
AntennaParameters.jsonalize_tree()	Create dictionary from the Binary Tree.
AntennaParameters.suppress_all(app)	Activate suppress option for all the operations contained in the binary tree node.
AntennaParameters.unsuppress_all(app)	Disable suppress option for all the operations contained in the binary tree node.
AntennaParameters.update_expressions_with_defaults([...])	Update the list of expressions by taking all quantities from a given category.
AntennaParameters.update_property(prop_name, ...)	Update the property of the binary tree node.
AntennaParameters.update_trace_in_report(traces)	Update a trace in a specific report.

Attributes

AntennaParameters.children
AntennaParameters.command	Command of the modeler hystory if available.
AntennaParameters.differential_pairs	Differential pairs flag.
AntennaParameters.domain	Plot domain.
AntennaParameters.expressions	Expressions.
AntennaParameters.far_field_sphere	Far field sphere name.
AntennaParameters.limit_lines	List of available limit lines in the report.
AntennaParameters.matrix	Maxwell 2D/3D or Q2D/Q3D matrix name.
AntennaParameters.notes	List of available notes in the report.
AntennaParameters.plot_name	Plot name.
AntennaParameters.polyline	Polyline name for the field report.
AntennaParameters.primary_sweep	Primary sweep report.
AntennaParameters.primary_sweep_range	Primary sweep range report.
AntennaParameters.properties	Properties data.
AntennaParameters.pulse_rise_time	Value of Pulse rise time for TDR plot.
AntennaParameters.reduced_matrix	Maxwell 2D/3D reduced matrix name for eddy current solvers.
AntennaParameters.report_category	Report category.
AntennaParameters.report_type	Report type.
AntennaParameters.secondary_sweep	Secondary sweep report.
AntennaParameters.secondary_sweep_range	Secondary sweep range report.
AntennaParameters.sub_design_id	Sub design ID for a Circuit or HFSS 3D Layout sub design.
AntennaParameters.time_start	Time start value.
AntennaParameters.time_stop	Time stop value.
AntennaParameters.time_windowing	Returns the TDR time windowing.
AntennaParameters.traces	List of available traces in the report.
AntennaParameters.use_pulse_in_tdr	Defines if the TDR should use a pulse or step.
AntennaParameters.variations	Variations.