MAPI service UserApplicationMonitoring

To get UserApplicationMonitoring service use:

with MAPIServices.instance.get_service("UserApplicationMonitoring") as uam:

Bases: MAPIServiceWithSignalR

UserApplicationMonitoring MAPI service allows to monitor a running MORPHEE application. For example, get MORPHEE status, get channel value, ... Call init_signalr if you intend to use the signalr hub events and with keyword on the UserApplicationMonitoring object to be sure that the communication is closed at the end.

Source code in restmapi\restmapi\services.py

class UserApplicationMonitoringProxy(MAPIServiceWithSignalR):
	"""UserApplicationMonitoring MAPI service allows to monitor a running MORPHEE application.
	For example, get MORPHEE status, get channel value, ...
	Call init_signalr if you intend to use the signalr hub events and with keyword on the UserApplicationMonitoring object to be sure that the communication is closed at the end.
	"""
	def __init__(self, url):
		"""DO NOT create UserApplicationMonitoringProxy by yourself. Always use MAPIServices.get_service("UserApplicationMonitoring") method to create it.

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

	def get_version(self):
		"""Current version of MAPI

		Returns
		-------
		string
			MAPI version
		"""
		return self.invoke_web_get_request("Version")

	def get_status(self):
		"""Get MORPHEE status. Be carefull it is differeent MORPHEE kernel status. It is a new set of values:
		<div class="grid table-desc" markdown>
		| Integer value | MORPHEE Status                 |
		|---------------|--------------------------------|
		|     1         | Start                          |
		|     2         | Security Red Level             |
		|     3         | Stop                           |
		|     4         | Running                        |
		|     5         | Security Orange level          |
		|     6         | Manual mode                    |
		|     7         | Suspended                      |
		|     8         | Error                          |
		|     9         | Bench mode loading/unloading   |
		|     10        | In mode Initializing cycle     |
		|     11        | In mode stopping cycle         |
		</div>

		Returns
		-------
		int
			Returns MORPHEE status
		"""
		return self.invoke_web_get_request("Status")

	def get_mode(self):
		"""Get Morphee current mode.
		* 0 for bench
		* 1 for campaign
		* 2 for test
		* Otherwise -1

		Returns
		-------
		int
			Returns Morphee current mode.
		"""
		return self.invoke_web_get_request("Mode")

	def get_channel_value(self, id):
		"""Get the value of a channel.

		Parameters
		----------
		id : string
			Id of a numerical quantity channel.

		Returns
		-------
		double
			Returns the current value of the quantity.
		"""
		return self.invoke_web_get_request(f"Channels/{id}/Value")

	def get_channel_text_value(self, id):
		"""Get a channel or constant value as a string.

		Parameters
		----------
		id : string
			Channel or Constant identifier

		Returns
		-------
		string
			Returns actual value of the channel or the constant.
		"""
		return self.invoke_web_get_request(f"Channels/{id}/TextValue")

	def get_channels_values(self, ids):
		"""Get channels values.
		If a channel does not exist an empty array is returned.

		Parameters
		----------
		ids : string array
			List of ids of a numerical quantities channel.

		Returns
		-------
		double array
			The result is an array of double that contains the value of each channels.
		"""
		return self.invoke_web_request("GetChannelsValues", "POST", ids)

	def get_dot_files_path(self):
		"""Get the path of the currently used .files file.

		Returns
		-------
		string
			Returns the path of the .files file.
		"""
		return self.invoke_web_get_request("FilesPath")

	def get_current_results(self):
		"""Result files description. It returns the content of the current .files.

		Returns
		-------
		MorpheeResultFileProxy array
			Each entry of the .files MORPHEE file.
		"""
		results = self.invoke_web_get_request("Results/current")
		return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/current", result) for result in results]

	def get_bench_results(self):
		"""Result files description. It returns the content of the bench .files.

		Returns
		-------
		MorpheeResultFileProxy array
			Each entry of the .files MORPHEE file.
		"""
		results = self.invoke_web_get_request(f"Results/bench")
		return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/bench", result) for result in results]

	def get_campaign_results(self):
		"""Result files description. It returns the content of the campaign .files.

		Returns
		-------
		MorpheeResultFileProxy array
			Each entry of the .files MORPHEE file.
		"""
		results = self.invoke_web_get_request(f"Results/campaign")
		return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/campaign", result) for result in results]

	def get_test_results(self):
		"""Result files description. It returns the content of the test .files.

		Returns
		-------
		MorpheeResultFileProxy array
			Each entry of the .files MORPHEE file.
		"""
		results = self.invoke_web_get_request(f"Results/test")
		return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/test", result) for result in results]

	def is_method_running(self, component, method):
		"""Test whether a method is running or not.

		Parameters
		----------
		component : string
			The component name that owns the method.
		method : string
			Method name.

		Returns
		-------
		bool
			Returns True if the method is running.
		"""
		return self.invoke_web_get_request(f"Components/Component/{component}/Methods/{method}/IsRunning")

	def get_quantities(self, skip, count):
		"""Get quantities name grouped by page.

		Parameters
		----------
		skip : int
			0 based index of the firs quantity of the page
		count : int
			Number of quantities in the page

		Returns
		-------
		string array
			Returns quantities name grouped by page.
		"""
		return self.invoke_web_get_request(f"Quantities/Ids?count={count}&skip={skip}")

	def get_component_quantities(self, component, skip, count):
		"""Get component quantities name grouped by page.

		Parameters
		----------
		component : string
			Component name (only the father name is sufficient).
		skip : int
			0 based index of the firs quantity of the page
		count : int
			Number of quantities in the page

		Returns
		-------
		string array
			Returns component quantities name grouped by page.
		"""
		return self.invoke_web_get_request(f"Components/Component/{component}/Quantities/Ids/?count={count}&skip={skip}")

	def get_quantities_properties(self, skip, count):
		"""Get quantities properties grouped by page.

		Parameters
		----------
		skip : int
			0 based start page index
		count : int
			Number of quantities per page

		Returns
		-------
		QuantityProperties array
			Returns quantities properties (see MORPHEE Quantities property description page).
		"""
		return self.invoke_web_get_request(f"Quantities/Properties?count={count}&skip={skip}")

	def get_component_quantities_properties(self, component, skip, count):
		"""Get component quantities properties

		Parameters
		----------
		component : string
			Component name (only the father name is sufficient).
		skip : int
			0 based start page index.
		count : int
			Number of quantities per page

		Returns
		-------
		QuantityProperties array
			Returns quantities properties (see MORPHEE Quantities property description page).
		"""
		return self.invoke_web_get_request(f"Components/Component/{component}/Quantities?count={count}&skip={skip}")

	def get_quantity_properties(self, id):
		"""Get quantity properties from quantity id.

		Parameters
		----------
		id : string
			Quantity id.

		Returns
		-------
		QuantityProperties
			Returns quantity properties (see MORPHEE Quantities property description page).
		"""
		return self.invoke_web_get_request(f"Quantities/Quantity/{id}")

	def get_quantity_value(self, id):
		"""Get quantity value from quantity id.
		Despite get_channel_text_value, all type are supported!

		Parameters
		----------
		id : string
			Quantity id.

		Returns
		-------
		string
			Returns quantity value from quantity id.
		"""
		return self.invoke_web_get_request(f"Quantities/Quantity/{id}/Value")

	def get_components(self, skip, count):
		"""Get components properties grouped by page.

		Parameters
		----------
		skip : int
			0 based index of the first component of the page
		count : int
			Number of components in the page

		Returns
		-------
		ComponentProperties array
			Component properties:
			<div class="grid table-desc" markdown>
			| **Type** | **Name** | **Description**                                     |
			|----------|----------|-----------------------------------------------------|
			| string   | name     | Father name of the component                        |
			| int      | mode     | Mode of the component (0 Bench, 1 Campaign, 2 Test) |
			| Method[] | methods  | Methods of the component                            |
			</div>
			Method properties:
			<div class="grid table-desc" markdown>
			| **Type** | **Name** | **Description**                           |
			|----------|----------|-------------------------------------------|
			| string   | name     | Method name                               |
			| bool     | isAlive  | Check if the method is currently running. |
			</div>
		"""
		return self.invoke_web_get_request(f"Components?count={count}&skip={skip}")

	def get_component(self, name):
		"""Get properties of a component from its name. 

		Parameters
		----------
		name : string
			Component father name

		Returns
		-------
		ComponentProperties
			Component properties:
			<div class="grid table-desc" markdown>
			| **Type** | **Name** | **Description**                                     |
			|----------|----------|-----------------------------------------------------|
			| string   | name     | Father name of the component                        |
			| int      | mode     | Mode of the component (0 Bench, 1 Campaign, 2 Test) |
			| Method[] | methods  | Methods of the component                            |
			</div>
			Method properties:
			<div class="grid table-desc" markdown>
			| **Type** | **Name** | **Description**                           |
			|----------|----------|-------------------------------------------|
			| string   | name     | Method name                               |
			| bool     | isAlive  | Check if the method is currently running. |
			</div>
		"""
		return self.invoke_web_get_request(f"Components/Component/{name}")

	def get_storage_keys(self, mode_name):
		"""List of available storage keys.

		Parameters
		----------
		mode_name : string
			Name of the mode (bench, campaign, test, current).

		Returns
		-------
		string array
			List of stoage keys of a mode.
		"""
		return self.invoke_web_get_request(f"StorageKeys/{mode_name}")

	def get_storage_key(self, name, mode_name):
		"""Get properties of a storage key.

		Parameters
		----------
		name : string
			Name of the storageKey
		mode_name : string
			Name of the mode (bench, campaign, test, current).

		Returns
		-------
		StorageKeyProperties
			Storage key properties
			<div class="grid table-desc" markdown>
			| **Type**               | **Name**         | **Description**                                                                 |
			|------------------------|------------------|---------------------------------------------------------------------------------|
			| string                 | name             | File group name                                                                 |
			| string                 | CurrentFilePath  | Current point file name                                                         |
			| string                 | LastFilePath     | Previous point file name                                                        |
			| bool                   | IsOpen           | True, if the point file is opened (that means that you cannot open it directly) |
			| int                    | NumberOfPoints   | Number of point written into the file                                           |
			</div>

		"""
		return self.invoke_web_get_request(f"StorageKeys/{mode_name}/{name}")

	def get_storage_key_quantities(self, name, mode_name):
		"""List of quantities to be stored into the file.

		Parameters
		----------
		name : string
			Name of the storageKey.
		mode_name : string
			Name of the mode (bench, campaign, test, current).

		Returns
		-------
		string array
			Quantities name.
		"""
		return self.invoke_web_get_request(f"StorageKeys/{mode_name}/{name}/Quantities")

	def get_measurement_manager(self) -> MeasurementManagerProxy:
		"""Get Measurement manager object that manages acquisition Measurement objects.

		Returns
		-------
		MeasurementManagerProxy
			Returns Measurement manager.
		"""
		return MeasurementManagerProxy(f"{self._mapi_base_url}/Measurement/")

	def register_callback(self, event_name, action):
		"""Register a callback function.
		inti_signalr() method should be called first.

		Parameters
		----------
		event_name : string
			MORPHEE event name. See MORPHEE documentation for default event names (e.g. "$BenchSarted").
		action : function(instance, name, params)
			Callback function with 3 parameters (int: MORPHEE instancenumber, string: name of the event, string: extra parameters).
		"""
		self.hub.server.invoke("register", event_name)
		self.hub.client.off('OnMorpheeEvent', action) # avoid that the same handler is registered twice
		self.hub.client.on('OnMorpheeEvent', action)

__init__(url)

DO NOT create UserApplicationMonitoringProxy by yourself. Always use MAPIServices.get_service("UserApplicationMonitoring") 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 UserApplicationMonitoringProxy by yourself. Always use MAPIServices.get_service("UserApplicationMonitoring") method to create it.

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

get_bench_results()

Result files description. It returns the content of the bench .files.

Returns:

• MorpheeResultFileProxy array –

  Each entry of the .files MORPHEE file.

Source code in restmapi\restmapi\services.py

def get_bench_results(self):
	"""Result files description. It returns the content of the bench .files.

	Returns
	-------
	MorpheeResultFileProxy array
		Each entry of the .files MORPHEE file.
	"""
	results = self.invoke_web_get_request(f"Results/bench")
	return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/bench", result) for result in results]

get_campaign_results()

Result files description. It returns the content of the campaign .files.

Returns:

• MorpheeResultFileProxy array –

  Each entry of the .files MORPHEE file.

Source code in restmapi\restmapi\services.py

def get_campaign_results(self):
	"""Result files description. It returns the content of the campaign .files.

	Returns
	-------
	MorpheeResultFileProxy array
		Each entry of the .files MORPHEE file.
	"""
	results = self.invoke_web_get_request(f"Results/campaign")
	return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/campaign", result) for result in results]

get_channel_text_value(id)

Get a channel or constant value as a string.

Parameters:

• id (string) –

  Channel or Constant identifier
  

Returns:

• string –

  Returns actual value of the channel or the constant.

Source code in restmapi\restmapi\services.py

def get_channel_text_value(self, id):
	"""Get a channel or constant value as a string.

	Parameters
	----------
	id : string
		Channel or Constant identifier

	Returns
	-------
	string
		Returns actual value of the channel or the constant.
	"""
	return self.invoke_web_get_request(f"Channels/{id}/TextValue")

get_channel_value(id)

Get the value of a channel.

Parameters:

• id (string) –

  Id of a numerical quantity channel.
  

Returns:

• double –

  Returns the current value of the quantity.

Source code in restmapi\restmapi\services.py

def get_channel_value(self, id):
	"""Get the value of a channel.

	Parameters
	----------
	id : string
		Id of a numerical quantity channel.

	Returns
	-------
	double
		Returns the current value of the quantity.
	"""
	return self.invoke_web_get_request(f"Channels/{id}/Value")

get_channels_values(ids)

Get channels values. If a channel does not exist an empty array is returned.

Parameters:

• ids (string array) –

  List of ids of a numerical quantities channel.
  

Returns:

• double array –

  The result is an array of double that contains the value of each channels.

Source code in restmapi\restmapi\services.py

def get_channels_values(self, ids):
	"""Get channels values.
	If a channel does not exist an empty array is returned.

	Parameters
	----------
	ids : string array
		List of ids of a numerical quantities channel.

	Returns
	-------
	double array
		The result is an array of double that contains the value of each channels.
	"""
	return self.invoke_web_request("GetChannelsValues", "POST", ids)

get_component(name)

Get properties of a component from its name.

Parameters:

• name (string) –

  Component father name
  

Returns:

• ComponentProperties –

  Component properties:

  Type	Name	Description
  string	name	Father name of the component
  int	mode	Mode of the component (0 Bench, 1 Campaign, 2 Test)
  Method[]	methods	Methods of the component

  Method properties:

  Type	Name	Description
  string	name	Method name
  bool	isAlive	Check if the method is currently running.

Source code in restmapi\restmapi\services.py

def get_component(self, name):
	"""Get properties of a component from its name. 

	Parameters
	----------
	name : string
		Component father name

	Returns
	-------
	ComponentProperties
		Component properties:
		<div class="grid table-desc" markdown>
		| **Type** | **Name** | **Description**                                     |
		|----------|----------|-----------------------------------------------------|
		| string   | name     | Father name of the component                        |
		| int      | mode     | Mode of the component (0 Bench, 1 Campaign, 2 Test) |
		| Method[] | methods  | Methods of the component                            |
		</div>
		Method properties:
		<div class="grid table-desc" markdown>
		| **Type** | **Name** | **Description**                           |
		|----------|----------|-------------------------------------------|
		| string   | name     | Method name                               |
		| bool     | isAlive  | Check if the method is currently running. |
		</div>
	"""
	return self.invoke_web_get_request(f"Components/Component/{name}")

get_component_quantities(component, skip, count)

Get component quantities name grouped by page.

Parameters:

• component (string) –

  Component name (only the father name is sufficient).
  

• skip (int) –

  0 based index of the firs quantity of the page
  

• count (int) –

  Number of quantities in the page
  

Returns:

• string array –

  Returns component quantities name grouped by page.

Source code in restmapi\restmapi\services.py

def get_component_quantities(self, component, skip, count):
	"""Get component quantities name grouped by page.

	Parameters
	----------
	component : string
		Component name (only the father name is sufficient).
	skip : int
		0 based index of the firs quantity of the page
	count : int
		Number of quantities in the page

	Returns
	-------
	string array
		Returns component quantities name grouped by page.
	"""
	return self.invoke_web_get_request(f"Components/Component/{component}/Quantities/Ids/?count={count}&skip={skip}")

get_component_quantities_properties(component, skip, count)

Get component quantities properties

Parameters:

• component (string) –

  Component name (only the father name is sufficient).
  

• skip (int) –

  0 based start page index.
  

• count (int) –

  Number of quantities per page
  

Returns:

• QuantityProperties array –

  Returns quantities properties (see MORPHEE Quantities property description page).

Source code in restmapi\restmapi\services.py

def get_component_quantities_properties(self, component, skip, count):
	"""Get component quantities properties

	Parameters
	----------
	component : string
		Component name (only the father name is sufficient).
	skip : int
		0 based start page index.
	count : int
		Number of quantities per page

	Returns
	-------
	QuantityProperties array
		Returns quantities properties (see MORPHEE Quantities property description page).
	"""
	return self.invoke_web_get_request(f"Components/Component/{component}/Quantities?count={count}&skip={skip}")

get_components(skip, count)

Get components properties grouped by page.

Parameters:

• skip (int) –

  0 based index of the first component of the page
  

• count (int) –

  Number of components in the page
  

Returns:

• ComponentProperties array –

  Component properties:

  Type	Name	Description
  string	name	Father name of the component
  int	mode	Mode of the component (0 Bench, 1 Campaign, 2 Test)
  Method[]	methods	Methods of the component

  Method properties:

  Type	Name	Description
  string	name	Method name
  bool	isAlive	Check if the method is currently running.

Source code in restmapi\restmapi\services.py

def get_components(self, skip, count):
	"""Get components properties grouped by page.

	Parameters
	----------
	skip : int
		0 based index of the first component of the page
	count : int
		Number of components in the page

	Returns
	-------
	ComponentProperties array
		Component properties:
		<div class="grid table-desc" markdown>
		| **Type** | **Name** | **Description**                                     |
		|----------|----------|-----------------------------------------------------|
		| string   | name     | Father name of the component                        |
		| int      | mode     | Mode of the component (0 Bench, 1 Campaign, 2 Test) |
		| Method[] | methods  | Methods of the component                            |
		</div>
		Method properties:
		<div class="grid table-desc" markdown>
		| **Type** | **Name** | **Description**                           |
		|----------|----------|-------------------------------------------|
		| string   | name     | Method name                               |
		| bool     | isAlive  | Check if the method is currently running. |
		</div>
	"""
	return self.invoke_web_get_request(f"Components?count={count}&skip={skip}")

get_current_results()

Result files description. It returns the content of the current .files.

Returns:

• MorpheeResultFileProxy array –

  Each entry of the .files MORPHEE file.

Source code in restmapi\restmapi\services.py

def get_current_results(self):
	"""Result files description. It returns the content of the current .files.

	Returns
	-------
	MorpheeResultFileProxy array
		Each entry of the .files MORPHEE file.
	"""
	results = self.invoke_web_get_request("Results/current")
	return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/current", result) for result in results]

get_dot_files_path()

Get the path of the currently used .files file.

Returns:

• string –

  Returns the path of the .files file.

Source code in restmapi\restmapi\services.py

def get_dot_files_path(self):
	"""Get the path of the currently used .files file.

	Returns
	-------
	string
		Returns the path of the .files file.
	"""
	return self.invoke_web_get_request("FilesPath")

get_measurement_manager()

Get Measurement manager object that manages acquisition Measurement objects.

Returns:

• MeasurementManagerProxy –

  Returns Measurement manager.

Source code in restmapi\restmapi\services.py

def get_measurement_manager(self) -> MeasurementManagerProxy:
	"""Get Measurement manager object that manages acquisition Measurement objects.

	Returns
	-------
	MeasurementManagerProxy
		Returns Measurement manager.
	"""
	return MeasurementManagerProxy(f"{self._mapi_base_url}/Measurement/")

get_mode()

Get Morphee current mode. * 0 for bench * 1 for campaign * 2 for test * Otherwise -1

Returns:

• int –

  Returns Morphee current mode.

Source code in restmapi\restmapi\services.py

def get_mode(self):
	"""Get Morphee current mode.
	* 0 for bench
	* 1 for campaign
	* 2 for test
	* Otherwise -1

	Returns
	-------
	int
		Returns Morphee current mode.
	"""
	return self.invoke_web_get_request("Mode")

get_quantities(skip, count)

Get quantities name grouped by page.

Parameters:

• skip (int) –

  0 based index of the firs quantity of the page
  

• count (int) –

  Number of quantities in the page
  

Returns:

• string array –

  Returns quantities name grouped by page.

Source code in restmapi\restmapi\services.py

def get_quantities(self, skip, count):
	"""Get quantities name grouped by page.

	Parameters
	----------
	skip : int
		0 based index of the firs quantity of the page
	count : int
		Number of quantities in the page

	Returns
	-------
	string array
		Returns quantities name grouped by page.
	"""
	return self.invoke_web_get_request(f"Quantities/Ids?count={count}&skip={skip}")

get_quantities_properties(skip, count)

Get quantities properties grouped by page.

Parameters:

• skip (int) –

  0 based start page index
  

• count (int) –

  Number of quantities per page
  

Returns:

• QuantityProperties array –

  Returns quantities properties (see MORPHEE Quantities property description page).

Source code in restmapi\restmapi\services.py

def get_quantities_properties(self, skip, count):
	"""Get quantities properties grouped by page.

	Parameters
	----------
	skip : int
		0 based start page index
	count : int
		Number of quantities per page

	Returns
	-------
	QuantityProperties array
		Returns quantities properties (see MORPHEE Quantities property description page).
	"""
	return self.invoke_web_get_request(f"Quantities/Properties?count={count}&skip={skip}")

get_quantity_properties(id)

Get quantity properties from quantity id.

Parameters:

• id (string) –

  Quantity id.
  

Returns:

• QuantityProperties –

  Returns quantity properties (see MORPHEE Quantities property description page).

Source code in restmapi\restmapi\services.py

def get_quantity_properties(self, id):
	"""Get quantity properties from quantity id.

	Parameters
	----------
	id : string
		Quantity id.

	Returns
	-------
	QuantityProperties
		Returns quantity properties (see MORPHEE Quantities property description page).
	"""
	return self.invoke_web_get_request(f"Quantities/Quantity/{id}")

get_quantity_value(id)

Get quantity value from quantity id. Despite get_channel_text_value, all type are supported!

Parameters:

• id (string) –

  Quantity id.
  

Returns:

• string –

  Returns quantity value from quantity id.

Source code in restmapi\restmapi\services.py

def get_quantity_value(self, id):
	"""Get quantity value from quantity id.
	Despite get_channel_text_value, all type are supported!

	Parameters
	----------
	id : string
		Quantity id.

	Returns
	-------
	string
		Returns quantity value from quantity id.
	"""
	return self.invoke_web_get_request(f"Quantities/Quantity/{id}/Value")

get_status()

Get MORPHEE status. Be carefull it is differeent MORPHEE kernel status. It is a new set of values:

Integer value	MORPHEE Status
1	Start
2	Security Red Level
3	Stop
4	Running
5	Security Orange level
6	Manual mode
7	Suspended
8	Error
9	Bench mode loading/unloading
10	In mode Initializing cycle
11	In mode stopping cycle

Returns:

• int –

  Returns MORPHEE status

Source code in restmapi\restmapi\services.py

def get_status(self):
	"""Get MORPHEE status. Be carefull it is differeent MORPHEE kernel status. It is a new set of values:
	<div class="grid table-desc" markdown>
	| Integer value | MORPHEE Status                 |
	|---------------|--------------------------------|
	|     1         | Start                          |
	|     2         | Security Red Level             |
	|     3         | Stop                           |
	|     4         | Running                        |
	|     5         | Security Orange level          |
	|     6         | Manual mode                    |
	|     7         | Suspended                      |
	|     8         | Error                          |
	|     9         | Bench mode loading/unloading   |
	|     10        | In mode Initializing cycle     |
	|     11        | In mode stopping cycle         |
	</div>

	Returns
	-------
	int
		Returns MORPHEE status
	"""
	return self.invoke_web_get_request("Status")

get_storage_key(name, mode_name)

Get properties of a storage key.

Parameters:

• name (string) –

  Name of the storageKey
  

• mode_name (string) –

  Name of the mode (bench, campaign, test, current).
  

Returns:

• StorageKeyProperties –

  Storage key properties

  Type	Name	Description
  string	name	File group name
  string	CurrentFilePath	Current point file name
  string	LastFilePath	Previous point file name
  bool	IsOpen	True, if the point file is opened (that means that you cannot open it directly)
  int	NumberOfPoints	Number of point written into the file

Source code in restmapi\restmapi\services.py

def get_storage_key(self, name, mode_name):
	"""Get properties of a storage key.

	Parameters
	----------
	name : string
		Name of the storageKey
	mode_name : string
		Name of the mode (bench, campaign, test, current).

	Returns
	-------
	StorageKeyProperties
		Storage key properties
		<div class="grid table-desc" markdown>
		| **Type**               | **Name**         | **Description**                                                                 |
		|------------------------|------------------|---------------------------------------------------------------------------------|
		| string                 | name             | File group name                                                                 |
		| string                 | CurrentFilePath  | Current point file name                                                         |
		| string                 | LastFilePath     | Previous point file name                                                        |
		| bool                   | IsOpen           | True, if the point file is opened (that means that you cannot open it directly) |
		| int                    | NumberOfPoints   | Number of point written into the file                                           |
		</div>

	"""
	return self.invoke_web_get_request(f"StorageKeys/{mode_name}/{name}")

get_storage_key_quantities(name, mode_name)

List of quantities to be stored into the file.

Parameters:

• name (string) –

  Name of the storageKey.
  

• mode_name (string) –

  Name of the mode (bench, campaign, test, current).
  

Returns:

• string array –

  Quantities name.

Source code in restmapi\restmapi\services.py

def get_storage_key_quantities(self, name, mode_name):
	"""List of quantities to be stored into the file.

	Parameters
	----------
	name : string
		Name of the storageKey.
	mode_name : string
		Name of the mode (bench, campaign, test, current).

	Returns
	-------
	string array
		Quantities name.
	"""
	return self.invoke_web_get_request(f"StorageKeys/{mode_name}/{name}/Quantities")

get_storage_keys(mode_name)

List of available storage keys.

Parameters:

• mode_name (string) –

  Name of the mode (bench, campaign, test, current).
  

Returns:

• string array –

  List of stoage keys of a mode.

Source code in restmapi\restmapi\services.py

def get_storage_keys(self, mode_name):
	"""List of available storage keys.

	Parameters
	----------
	mode_name : string
		Name of the mode (bench, campaign, test, current).

	Returns
	-------
	string array
		List of stoage keys of a mode.
	"""
	return self.invoke_web_get_request(f"StorageKeys/{mode_name}")

get_test_results()

Result files description. It returns the content of the test .files.

Returns:

• MorpheeResultFileProxy array –

  Each entry of the .files MORPHEE file.

Source code in restmapi\restmapi\services.py

def get_test_results(self):
	"""Result files description. It returns the content of the test .files.

	Returns
	-------
	MorpheeResultFileProxy array
		Each entry of the .files MORPHEE file.
	"""
	results = self.invoke_web_get_request(f"Results/test")
	return [MorpheeResultFileProxy(f"{self._mapi_base_url}/Results/test", result) for result in results]

get_version()

Current version of MAPI

Returns:

• string –

  MAPI version

Source code in restmapi\restmapi\services.py

def get_version(self):
	"""Current version of MAPI

	Returns
	-------
	string
		MAPI version
	"""
	return self.invoke_web_get_request("Version")

is_method_running(component, method)

Test whether a method is running or not.

Parameters:

• component (string) –

  The component name that owns the method.
  

• method (string) –

  Method name.
  

Returns:

• bool –

  Returns True if the method is running.

Source code in restmapi\restmapi\services.py

def is_method_running(self, component, method):
	"""Test whether a method is running or not.

	Parameters
	----------
	component : string
		The component name that owns the method.
	method : string
		Method name.

	Returns
	-------
	bool
		Returns True if the method is running.
	"""
	return self.invoke_web_get_request(f"Components/Component/{component}/Methods/{method}/IsRunning")

register_callback(event_name, action)

Register a callback function. inti_signalr() method should be called first.

Parameters:

• event_name (string) –

  MORPHEE event name. See MORPHEE documentation for default event names (e.g. "$BenchSarted").
  

• action (function(instance, name, params)) –

  Callback function with 3 parameters (int: MORPHEE instancenumber, string: name of the event, string: extra parameters).
  

Source code in restmapi\restmapi\services.py

def register_callback(self, event_name, action):
	"""Register a callback function.
	inti_signalr() method should be called first.

	Parameters
	----------
	event_name : string
		MORPHEE event name. See MORPHEE documentation for default event names (e.g. "$BenchSarted").
	action : function(instance, name, params)
		Callback function with 3 parameters (int: MORPHEE instancenumber, string: name of the event, string: extra parameters).
	"""
	self.hub.server.invoke("register", event_name)
	self.hub.client.off('OnMorpheeEvent', action) # avoid that the same handler is registered twice
	self.hub.client.on('OnMorpheeEvent', action)