Revision#

class ansys.aedt.core.emit_core.results.revision.Revision(parent_results, emit_project, name: str | None = None)#

Provides the Revision object.

Parameters:
parent_results

Results object that this revision is associated with.

emit_projectEmit

Emit object that this revision is associated with.

namestr, optional

Name of the revision to load . The default is None, in which case the Current revision is used.

Raises:
RuntimeError if the name given is not the name of an existing result set and a current result set already exists.

Examples

Create a Revision instance.

>>> aedtapp = Emit()
>>> rev = Revision(results, aedtapp, "Revision 1")
>>> domain = aedtapp.interaction_domain()
>>> rev.run(domain)

Methods

Revision.get_active_frequencies(radio_name, ...)

Get a list of active frequencies for a tx or rx band in a radio/emitter.

Revision.get_all_band_nodes(radio[, ...])

Returns all the Bands within a Radio

Revision.get_all_component_nodes()

Gets all component nodes from this revision.

Revision.get_all_emitter_radios()

Gets all Emitter Radio nodes from this revision.

Revision.get_all_nodes()

Gets all nodes for this revision.

Revision.get_all_radio_nodes([tx_rx_mode, ...])

Gets all Radio nodes from this revision.

Revision.get_all_top_level_nodes()

Gets all top level nodes from this revision.

Revision.get_band_names([radio_node, ...])

Get a list of all enabled tx or rx bands (or waveforms) in a given radio/emitter.

Revision.get_band_node(band_name)

Get a Band node by name.

Revision.get_component_node(component_name)

Gets the component node.

Revision.get_coupling_data_node()

Gets the Coupling Data node for this revision.

Revision.get_interferer_names([...])

Get a list of all interfering transmitters/emitters in the project.

Revision.get_preferences_node()

Gets the Preferences node for this revision.

Revision.get_radio_node(radio_name)

Gets a Radio node by name.

Revision.get_receiver_names([domain_filter])

Get a list of all receivers in the project.

Revision.get_result_categorization_node()

Gets the Result Categorization node for this revision.

Revision.get_result_plot_node()

Gets the Result Plot node for this revision.

Revision.get_scene_node()

Gets the Scene node for this revision.

Revision.get_simulation()

Get the simulation object for this revision.

Revision.get_simulation_node()

Gets the Simulation node for this revision.

Revision.result_mode_error()

Print the function mode error message.

Attributes

Revision.notes

Add notes to the revision.

Revision.emit_project

EMIT project.

Revision.odesktop

Desktop object.

Revision.parent_results

Parent Results object.

Revision.aedt_version

AEDT version.

Revision.name

Name of the revision.

Revision.path

Full path of the revision.

Revision.results_index

Index of the result for this revision.

Revision.revision_number

Unique revision number from the EMIT design

Revision.timestamp

Unique timestamp for the revision

Revision.revision_loaded

True if the revision is loaded and False if it is not.