add_interface

class ansys.systemcoupling.core.adaptor.api_25_2.add_interface.add_interface(name=None, parent=None)

Bases: Command

Adds an interface based on the participant and region names specified as arguments for each side of the interface. This command requires that you specify participants using their names as described below in Essential Keyword Arguments. Non-FMU participants can provide a list of regions as described below in Optional Keyword Arguments. For FMU interfaces, specifying the regions are not allowed.

Cannot be run after participants have been started.

Returns the name of the Interface created.

Parameters:

side_one_participantstr

String indicating the name of the participant to be associated with side “One” of the interface.

side_two_participantstr

String indicating the name of the participant to be associated with side “Two”of the interface.

side_one_regionsList, optional

List specifying the name(s) of region(s) to be added to side One of the interface. Must be provided if side_one_participant is not an FMU.

side_two_regionsList, optional

List specifying the name(s) of region(s) to be added to side Two of the interface. Must be provided if side_one_participant is not an FMU.

Included in:

Parent	Summary
setup_root	‘root’ object