MCDProcess#

class MCDProcess#

Launches and keeps track of a ModelCenter Desktop process.

Overview#

start

Start the ModelCenter Desktop process.

get_process_id

Get the process ID of the ModelCenter Desktop process.

Import detail#

from ansys.modelcenter.workflow.grpc_modelcenter.mcd_process import MCDProcess

Method detail#

MCDProcess.start(run_only: bool = False, heartbeat_interval: numpy.uint = 30000, allowed_heartbeat_misses: numpy.uint = 3) int#

Start the ModelCenter Desktop process.

Parameters:
run_onlybool, optional

Whether to start ModelCenter in run-only mode. The default is False.

heartbeat_intervalnumpy.uint, optional

Interval between heartbeat messages. The default is 30000.

allowed_heartbeat_missesnumpy.uint, optional

Number of allowed missed heartbeats before the server terminates. The default is 3.

Returns:
int

Port number that the gRPC server was started on.

MCDProcess.get_process_id() int#

Get the process ID of the ModelCenter Desktop process.