MAPI service SimulationControl

IMPORTANT: This service is available only with xMOD.

To get SimulationControl service use:

with MAPIServices.instance.get_service("SimulationControl") as sc:

Bases: MAPIServiceWithSignalR

SimulationControl MAPI service allows to control simulations.

Source code in restmapi\restmapi\services.py

class SimulationControlRestServiceProxy(MAPIServiceWithSignalR):
	"""SimulationControl MAPI service allows to control simulations.
	"""
	def __init__(self, url):
		"""DO NOT create SimulationControlRestServiceProxy by yourself. Always use MAPIServices.get_service("SimulationControl") method to create it.

		Parameters
		----------
		url : string
			Base URL to create of the REST service.
		"""
		super().__init__(url, "SimulationControl")

	def start_simulation(self, name, xpar_parameters=None):
		"""Start new simulation

		Parameters
		----------
		name : string
			Simulation name
		xpar_parameters : bytes or string, optional
			XPAR parameters content, by default None
		"""
		url = f"start?name={name}"
		if xpar_parameters is not None:
			self.invoke_web_request(url, "POST", xpar_parameters, raw=True)
		else:
			self.invoke_web_post_request(url)

	def stop_simulation(self):
		"""Stop current simulation
		"""
		self.invoke_web_post_request("stop")

	def get_status(self):
		"""Get current simulation status

		Returns
		-------
		string
			Simulation status
		"""
		return self.invoke_web_get_request("status")

	def has_started(self):
		"""Get the information if the simulation has started

		Returns
		-------
		bool
			True if started
		"""
		return self.invoke_web_get_request("has_started")

	def pause_simulation(self):
		"""Pause current simulation
		"""
		self.invoke_web_post_request("pause")

	def resume_simulation(self):
		"""Resume current simulation
		"""
		self.invoke_web_post_request("resume")

	def get_current_name(self):
		"""Get current simulation name

		Returns
		-------
		string
			Simulation name
		"""
		return self.invoke_web_get_request("name")

	def get_simulation_progress(self):
		"""Get current simulation progress in percentage

		Returns
		-------
		int
			Progress percentage
		"""
		return self.invoke_web_get_request("progress")

	def delete_simulation(self, name):
		"""Delete simulation

		Parameters
		----------
		name : string
			Simulation name
		"""
		self.invoke_web_request(f"simulations/{name}", "DELETE")

	def get_simulations_list(self):
		"""Get list of all simulations

		Returns
		-------
		string array
			List of simulation names
		"""
		return self.invoke_web_get_request("simulations")

	def get_simulation_details(self, name):
		"""Get simulation details

		Parameters
		----------
		name : string
			Simulation name

		Returns
		-------
		SimulationDetails
			Simulation details object
		"""
		return self.invoke_web_get_request(f"simulations/{name}/details")

	def get_simulation_settings(self, name):
		"""Get simulation settings

		Parameters
		----------
		name : string
			Simulation name

		Returns
		-------
		SimulationSettings
			Simulation settings object
		"""
		return self.invoke_web_get_request(f"simulations/{name}/settings")

	def set_simulation_settings(self, name, settings):
		"""Set simulation settings

		Parameters
		----------
		name : string
			Simulation name
		settings : SimulationSettings
			Simulation settings object
		"""
		self.invoke_web_request(f"simulations/{name}/settings", "POST", settings)

	def get_variables(self, filter_str, format_str, skip=0, count=100):
		"""Get variables list

		Parameters
		----------
		filter_str : string
			Filter
		format_str : string
			Return format(json or string)
		skip : int, optional
			Number of variables to skip, by default 0
		count : int, optional
			Maximum number of variables to return, by default 100

		Returns
		-------
		object array
			List of variables
		"""
		return self.invoke_web_get_request(f"variables?filter={filter_str}&format={format_str}&skip={skip}&count={count}")

	def get_variables_values(self, names):
		"""Set variable value

		Parameters
		----------
		names : string array
			Quantity names

		Returns
		-------
		Variable array
			List of variables with values
		"""
		return self.invoke_web_request("variablesvalues", "POST", names)

	def get_channel_value(self, channel_name):
		"""Get channel current value

		Parameters
		----------
		channel_name : string
			Channel name

		Returns
		-------
		double
			Channel value
		"""
		return self.invoke_web_get_request(f"channels/{channel_name}/value")

	def get_table_value(self, table_name):
		"""Get table current value

		Parameters
		----------
		table_name : string
			Table name

		Returns
		-------
		string
			Table value
		"""
		return self.invoke_web_get_request(f"tables/{table_name}/value")

	def set_channel_value(self, channel_name, value):
		"""Set channel value

		Parameters
		----------
		channel_name : string
			Channel name
		value : double
			Value to be set
		"""
		self.invoke_web_request(f"channels/{channel_name}/value", "POST", value)

	def set_table_value(self, table_name, value):
		"""Set table value

		Parameters
		----------
		table_name : string
			Table name
		value : double array array
			Value to be set
		"""
		self.invoke_web_request(f"tables/{table_name}/value", "POST", value)

	def get_result_file(self, path, group, id):
		"""Get results file content

		Parameters
		----------
		path : string
			Results subfolder name
		group : string
			Section in .files
		id : string
			Id of the file

		Returns
		-------
		bytes
			File content
		"""
		return self.invoke_web_request(f"results/{path}/{group}/{id}", "GET", raw=True).content

	def get_result_files(self, path):
		"""Get results files

		Parameters
		----------
		path : string
			Results subfolder name

		Returns
		-------
		ResultFile array
			List of result files
		"""
		return self.invoke_web_get_request(f"results/{path}")

	def get_results_url_array(self, filter_str, skip=0, count=100):
		"""Get results array

		Parameters
		----------
		filter_str : string
			Filter
		skip : int, optional
			Number of results to skip, by default 0
		count : int, optional
			Maximum number of results to return, by default 100

		Returns
		-------
		string array
			List of result URLs
		"""
		return self.invoke_web_get_request(f"results/list?filter={filter_str}&count={count}&skip={skip}")

	def get_last_result(self):
		"""Get last results subfolder name

		Returns
		-------
		string
			Last result subfolder name
		"""
		return self.invoke_web_get_request("results/last")

	def get_last_log_files_zip(self):
		"""Get last log files zip archive

		Returns
		-------
		bytes
			Zip archive content
		"""
		return self.invoke_web_request("results/last_log_files", "GET", raw=True).content

	def get_last_report_messages(self):
		"""Get last report messages

		Returns
		-------
		RestReportMessage array
			List of report messages
		"""
		return self.invoke_web_get_request("results/last_report_messages")

	def get_parameters(self, name):
		"""Get parameters array for specific simulation

		Parameters
		----------
		name : string
			Simulation name

		Returns
		-------
		Parameter array
			List of parameters
		"""
		return self.invoke_web_get_request(f"simulations/{name}/parameters")

	def register_status_changed_callback(self, action):
		"""Register a signalR callback to be called when the simulation status changes.
		init_signalr() method has to be called before to initialize signalR communication.

		Parameters
		----------
		action : Function with a string parameter
			A callback function with a parameter (new status).
		"""
		self.hub.client.on('StatusChanged', action)

__init__(url)

DO NOT create SimulationControlRestServiceProxy by yourself. Always use MAPIServices.get_service("SimulationControl") method to create it.

Parameters:

• url (string) –

  Base URL to create of the REST service.
  

Source code in restmapi\restmapi\services.py

def __init__(self, url):
	"""DO NOT create SimulationControlRestServiceProxy by yourself. Always use MAPIServices.get_service("SimulationControl") method to create it.

	Parameters
	----------
	url : string
		Base URL to create of the REST service.
	"""
	super().__init__(url, "SimulationControl")

delete_simulation(name)

Delete simulation

Parameters:

• name (string) –

  Simulation name
  

Source code in restmapi\restmapi\services.py

def delete_simulation(self, name):
	"""Delete simulation

	Parameters
	----------
	name : string
		Simulation name
	"""
	self.invoke_web_request(f"simulations/{name}", "DELETE")

get_channel_value(channel_name)

Get channel current value

Parameters:

• channel_name (string) –

  Channel name
  

Returns:

• double –

  Channel value

Source code in restmapi\restmapi\services.py

def get_channel_value(self, channel_name):
	"""Get channel current value

	Parameters
	----------
	channel_name : string
		Channel name

	Returns
	-------
	double
		Channel value
	"""
	return self.invoke_web_get_request(f"channels/{channel_name}/value")

get_current_name()

Get current simulation name

Returns:

• string –

  Simulation name

Source code in restmapi\restmapi\services.py

def get_current_name(self):
	"""Get current simulation name

	Returns
	-------
	string
		Simulation name
	"""
	return self.invoke_web_get_request("name")

get_last_log_files_zip()

Get last log files zip archive

Returns:

• bytes –

  Zip archive content

Source code in restmapi\restmapi\services.py

def get_last_log_files_zip(self):
	"""Get last log files zip archive

	Returns
	-------
	bytes
		Zip archive content
	"""
	return self.invoke_web_request("results/last_log_files", "GET", raw=True).content

get_last_report_messages()

Get last report messages

Returns:

• RestReportMessage array –

  List of report messages

Source code in restmapi\restmapi\services.py

def get_last_report_messages(self):
	"""Get last report messages

	Returns
	-------
	RestReportMessage array
		List of report messages
	"""
	return self.invoke_web_get_request("results/last_report_messages")

get_last_result()

Get last results subfolder name

Returns:

• string –

  Last result subfolder name

Source code in restmapi\restmapi\services.py

def get_last_result(self):
	"""Get last results subfolder name

	Returns
	-------
	string
		Last result subfolder name
	"""
	return self.invoke_web_get_request("results/last")

get_parameters(name)

Get parameters array for specific simulation

Parameters:

• name (string) –

  Simulation name
  

Returns:

• Parameter array –

  List of parameters

Source code in restmapi\restmapi\services.py

def get_parameters(self, name):
	"""Get parameters array for specific simulation

	Parameters
	----------
	name : string
		Simulation name

	Returns
	-------
	Parameter array
		List of parameters
	"""
	return self.invoke_web_get_request(f"simulations/{name}/parameters")

get_result_file(path, group, id)

Get results file content

Parameters:

• path (string) –

  Results subfolder name
  

• group (string) –

  Section in .files
  

• id (string) –

  Id of the file
  

Returns:

• bytes –

  File content

Source code in restmapi\restmapi\services.py

def get_result_file(self, path, group, id):
	"""Get results file content

	Parameters
	----------
	path : string
		Results subfolder name
	group : string
		Section in .files
	id : string
		Id of the file

	Returns
	-------
	bytes
		File content
	"""
	return self.invoke_web_request(f"results/{path}/{group}/{id}", "GET", raw=True).content

get_result_files(path)

Get results files

Parameters:

• path (string) –

  Results subfolder name
  

Returns:

• ResultFile array –

  List of result files

Source code in restmapi\restmapi\services.py

def get_result_files(self, path):
	"""Get results files

	Parameters
	----------
	path : string
		Results subfolder name

	Returns
	-------
	ResultFile array
		List of result files
	"""
	return self.invoke_web_get_request(f"results/{path}")

get_results_url_array(filter_str, skip=0, count=100)

Get results array

Parameters:

• filter_str (string) –

  Filter
  

• skip (int, default: 0 ) –

  Number of results to skip, by default 0
  

• count (int, default: 100 ) –

  Maximum number of results to return, by default 100
  

Returns:

• string array –

  List of result URLs

Source code in restmapi\restmapi\services.py

def get_results_url_array(self, filter_str, skip=0, count=100):
	"""Get results array

	Parameters
	----------
	filter_str : string
		Filter
	skip : int, optional
		Number of results to skip, by default 0
	count : int, optional
		Maximum number of results to return, by default 100

	Returns
	-------
	string array
		List of result URLs
	"""
	return self.invoke_web_get_request(f"results/list?filter={filter_str}&count={count}&skip={skip}")

get_simulation_details(name)

Get simulation details

Parameters:

• name (string) –

  Simulation name
  

Returns:

• SimulationDetails –

  Simulation details object

Source code in restmapi\restmapi\services.py

def get_simulation_details(self, name):
	"""Get simulation details

	Parameters
	----------
	name : string
		Simulation name

	Returns
	-------
	SimulationDetails
		Simulation details object
	"""
	return self.invoke_web_get_request(f"simulations/{name}/details")

get_simulation_progress()

Get current simulation progress in percentage

Returns:

• int –

  Progress percentage

Source code in restmapi\restmapi\services.py

def get_simulation_progress(self):
	"""Get current simulation progress in percentage

	Returns
	-------
	int
		Progress percentage
	"""
	return self.invoke_web_get_request("progress")

get_simulation_settings(name)

Get simulation settings

Parameters:

• name (string) –

  Simulation name
  

Returns:

• SimulationSettings –

  Simulation settings object

Source code in restmapi\restmapi\services.py

def get_simulation_settings(self, name):
	"""Get simulation settings

	Parameters
	----------
	name : string
		Simulation name

	Returns
	-------
	SimulationSettings
		Simulation settings object
	"""
	return self.invoke_web_get_request(f"simulations/{name}/settings")

get_simulations_list()

Get list of all simulations

Returns:

• string array –

  List of simulation names

Source code in restmapi\restmapi\services.py

def get_simulations_list(self):
	"""Get list of all simulations

	Returns
	-------
	string array
		List of simulation names
	"""
	return self.invoke_web_get_request("simulations")

get_status()

Get current simulation status

Returns:

• string –

  Simulation status

Source code in restmapi\restmapi\services.py

def get_status(self):
	"""Get current simulation status

	Returns
	-------
	string
		Simulation status
	"""
	return self.invoke_web_get_request("status")

get_table_value(table_name)

Get table current value

Parameters:

• table_name (string) –

  Table name
  

Returns:

• string –

  Table value

Source code in restmapi\restmapi\services.py

def get_table_value(self, table_name):
	"""Get table current value

	Parameters
	----------
	table_name : string
		Table name

	Returns
	-------
	string
		Table value
	"""
	return self.invoke_web_get_request(f"tables/{table_name}/value")

get_variables(filter_str, format_str, skip=0, count=100)

Get variables list

Parameters:

• filter_str (string) –

  Filter
  

• format_str (string) –

  Return format(json or string)
  

• skip (int, default: 0 ) –

  Number of variables to skip, by default 0
  

• count (int, default: 100 ) –

  Maximum number of variables to return, by default 100
  

Returns:

• object array –

  List of variables

Source code in restmapi\restmapi\services.py

def get_variables(self, filter_str, format_str, skip=0, count=100):
	"""Get variables list

	Parameters
	----------
	filter_str : string
		Filter
	format_str : string
		Return format(json or string)
	skip : int, optional
		Number of variables to skip, by default 0
	count : int, optional
		Maximum number of variables to return, by default 100

	Returns
	-------
	object array
		List of variables
	"""
	return self.invoke_web_get_request(f"variables?filter={filter_str}&format={format_str}&skip={skip}&count={count}")

get_variables_values(names)

Set variable value

Parameters:

• names (string array) –

  Quantity names
  

Returns:

• Variable array –

  List of variables with values

Source code in restmapi\restmapi\services.py

def get_variables_values(self, names):
	"""Set variable value

	Parameters
	----------
	names : string array
		Quantity names

	Returns
	-------
	Variable array
		List of variables with values
	"""
	return self.invoke_web_request("variablesvalues", "POST", names)

has_started()

Get the information if the simulation has started

Returns:

• bool –

  True if started

Source code in restmapi\restmapi\services.py

def has_started(self):
	"""Get the information if the simulation has started

	Returns
	-------
	bool
		True if started
	"""
	return self.invoke_web_get_request("has_started")

pause_simulation()

Pause current simulation

Source code in restmapi\restmapi\services.py

def pause_simulation(self):
	"""Pause current simulation
	"""
	self.invoke_web_post_request("pause")

register_status_changed_callback(action)

Register a signalR callback to be called when the simulation status changes. init_signalr() method has to be called before to initialize signalR communication.

Parameters:

• action (Function with a string parameter) –

  A callback function with a parameter (new status).
  

Source code in restmapi\restmapi\services.py

def register_status_changed_callback(self, action):
	"""Register a signalR callback to be called when the simulation status changes.
	init_signalr() method has to be called before to initialize signalR communication.

	Parameters
	----------
	action : Function with a string parameter
		A callback function with a parameter (new status).
	"""
	self.hub.client.on('StatusChanged', action)

resume_simulation()

Resume current simulation

Source code in restmapi\restmapi\services.py

def resume_simulation(self):
	"""Resume current simulation
	"""
	self.invoke_web_post_request("resume")

set_channel_value(channel_name, value)

Set channel value

Parameters:

• channel_name (string) –

  Channel name
  

• value (double) –

  Value to be set
  

Source code in restmapi\restmapi\services.py

def set_channel_value(self, channel_name, value):
	"""Set channel value

	Parameters
	----------
	channel_name : string
		Channel name
	value : double
		Value to be set
	"""
	self.invoke_web_request(f"channels/{channel_name}/value", "POST", value)

set_simulation_settings(name, settings)

Set simulation settings

Parameters:

• name (string) –

  Simulation name
  

• settings (SimulationSettings) –

  Simulation settings object
  

Source code in restmapi\restmapi\services.py

def set_simulation_settings(self, name, settings):
	"""Set simulation settings

	Parameters
	----------
	name : string
		Simulation name
	settings : SimulationSettings
		Simulation settings object
	"""
	self.invoke_web_request(f"simulations/{name}/settings", "POST", settings)

set_table_value(table_name, value)

Set table value

Parameters:

• table_name (string) –

  Table name
  

• value (double array array) –

  Value to be set
  

Source code in restmapi\restmapi\services.py

def set_table_value(self, table_name, value):
	"""Set table value

	Parameters
	----------
	table_name : string
		Table name
	value : double array array
		Value to be set
	"""
	self.invoke_web_request(f"tables/{table_name}/value", "POST", value)

start_simulation(name, xpar_parameters=None)

Start new simulation

Parameters:

• name (string) –

  Simulation name
  

• xpar_parameters (bytes or string, default: None ) –

  XPAR parameters content, by default None
  

Source code in restmapi\restmapi\services.py

def start_simulation(self, name, xpar_parameters=None):
	"""Start new simulation

	Parameters
	----------
	name : string
		Simulation name
	xpar_parameters : bytes or string, optional
		XPAR parameters content, by default None
	"""
	url = f"start?name={name}"
	if xpar_parameters is not None:
		self.invoke_web_request(url, "POST", xpar_parameters, raw=True)
	else:
		self.invoke_web_post_request(url)

stop_simulation()

Stop current simulation

Source code in restmapi\restmapi\services.py

def stop_simulation(self):
	"""Stop current simulation
	"""
	self.invoke_web_post_request("stop")