ansys.systemcoupling.core.adaptor.impl.types.InjectedCommand

class ansys.systemcoupling.core.adaptor.impl.types.InjectedCommand(name=None, parent=None)

Provides a base class for calling a locally defined function that has been injected into the generated API hierarchy so that it appears alongside the generic commands.

This class can also be used to override an existing API command with a local version. In this case the syc_name refers to the remote System Coupling command name. If the command is not an override, the syc_name is the same as the local function name.

In all cases, the cmd_name attribute that is specific to this class is set and used as the definitive name to call on the proxy interface.

Attributes:

cmd_name

Methods

__init__([name, parent])	Initialize an instance of the Base class.
set_sycproxy(sycproxy)	Set sycproxy object.

Attributes

cmd_name
obj_name	System Coupling name of this object.
path	Path of the object.
syc_name
syc_path	Path of the object in native System Coupling form.
sycproxy	Proxy object.