Package ASAM :: Package HILAPI :: Package Concurrent :: Package Platform :: Module Concurrent :: Class Concurrent

Class Concurrent

Interfaces.Platform.IPlatform.IPlatform --+    
                                          |    
       Interfaces.Platform.IPlatform.IPlant --+
                                              |
                                             Concurrent


This is the over-arching class for all CCUR SimWB ASAM AE HIL target platforms.

The ASAM MAPort, with respect to SimWB, has an inherent problem in that the
target must already be running a test when the MAPort is created.  But SimWB
requires that logging be configured prior to test start.  It is the SimWB
logger that is leveredged for MAPort data captures.  This and other reasons
necessitated the creation of this encompassing class.

NOTE:
    * most methods require a 'sharedDictionary' argument.  This is unused
      by SimWB, and defaults to None.

    * the optional 'local_dictionary' argument to the Platform object is
      required by SimWB.

    * Importing this module automatically enables ASAM function logging.
      The log file Concurrent.log will be created in the current working
      directory.

Instance Methods

__init__(self, local_dictionary={}, platform_id=None)

__repr__(self)

get_lib_path(self)
Returns the ASAM library path where the owning implementation is located.

get_path_calibratable(self, path)
Given a variable name in 'path', return the path or variable name appropriate for a SimWB target.

get_path_calibratable_abstrct(self, path)
See 'get_path_calibratable()'.

get_path_measurement(self, path)
See 'get_path_calibratable()'.

get_path_measurement_abstrct(self, path)
See 'get_path_calibratable_abstrct()'.

get_simulation_time_sec(self)
Returns the SimWB simulation time.

init_ElectricalErrorSimulationPort(self, sharedDictionary=None)
Return an instance of a SimWB Electric Error Simulation Port (EESPort).

init_ModelAccessPort(self, sharedDictionary=None)
Return an instance of a SimWB Model Access Port (MAPort).

init_SignalAbstraction(self, sharedDictionary=None)
Unimplimented

load_model(self, sharedDictionary=None)
Run the configured test on the target.

pause_platform(self, sharedDictionary=None)
Pauses the running test.

quit_platform(self, sharedDictionary=None)
Close all MAPorts, stop the test and disconnect from the host.

reset_platform(self, sharedDictionary=None)
Stop the test.

start_platform(self, configFile=None, interestList=None)
Configure the ASAM target for a SimWB test.

unpause_platform(self, sharedDictionary=None)
Resumes a paused test.

Static Methods

__is__(manufacturer)

Class Variables
	platform_id = `'default'`
	platform_name = `'default'`
	platform_type = `'Concurrent'`
Inherited from `Interfaces.Platform.IPlatform.IPlatform`: `model_location`

Method Details

init(self, local_dictionary=`{}`, platform_id=None)
(Constructor)

Overrides: Interfaces.Platform.IPlatform.IPlatform.__init__: (inherited documentation)

get_lib_path(self)

Returns the ASAM library path where the owning implementation is located.

Overrides: Interfaces.Platform.IPlatform.IPlatform.get_lib_path

get_path_calibratable(self, path)

Given a variable name in 'path', return the path or variable name appropriate for a SimWB target.

This path can be a parameter, signal or RTDB name.

If a TRC or ABS file is detected upon platform initialization, then the path may also be a name defined by one of these files (this method is specific to Ford implementations and requires additional module support).

SimWB does not differentiate between calibratables and measurements.

If a path can't be resolved, or is ambiguous, an exception is raised.

The path may be a string, or a list of strings. If a list then a list will be returned.

Overrides: Interfaces.Platform.IPlatform.IPlatform.get_path_calibratable

get_path_calibratable_abstrct(self, path)

See 'get_path_calibratable()'.

The return is somewhat different in that a ConcurrentSignalInformation object is returned. A bad lookup will not result in an object (i.e a None is returned).

Overrides: Interfaces.Platform.IPlatform.IPlatform.get_path_calibratable_abstrct

get_path_measurement(self, path)

See 'get_path_calibratable()'.

Overrides: Interfaces.Platform.IPlatform.IPlatform.get_path_measurement

get_path_measurement_abstrct(self, path)

See 'get_path_calibratable_abstrct()'.

Overrides: Interfaces.Platform.IPlatform.IPlatform.get_path_measurement_abstrct

get_simulation_time_sec(self)

Returns the SimWB simulation time.

Overrides: Interfaces.Platform.IPlatform.IPlatform.get_simulation_time_sec

init_ElectricalErrorSimulationPort(self, sharedDictionary=None)

Return an instance of a SimWB Electric Error Simulation Port (EESPort).

Overrides: Interfaces.Platform.IPlatform.IPlant.init_ElectricalErrorSimulationPort

init_ModelAccessPort(self, sharedDictionary=None)

Return an instance of a SimWB Model Access Port (MAPort).

Overrides: Interfaces.Platform.IPlatform.IPlant.init_ModelAccessPort

init_SignalAbstraction(self, sharedDictionary=None)

Unimplimented

Overrides: Interfaces.Platform.IPlatform.IPlatform.init_SignalAbstraction

load_model(self, sharedDictionary=None)

Run the configured test on the target.

This method waits until the target indicates the test is running. A start_platform() must have previously been executed.

pause_platform(self, sharedDictionary=None)

Pauses the running test.

Pausing a paused test is okay.

Overrides: Interfaces.Platform.IPlatform.IPlant.pause_platform

quit_platform(self, sharedDictionary=None)

Close all MAPorts, stop the test and disconnect from the host.

A start_platform() must have previously been executed.

Overrides: Interfaces.Platform.IPlatform.IPlatform.quit_platform

reset_platform(self, sharedDictionary=None)

Stop the test.

This method waits until the target indicates the test is stopped. Stopping a stopped test is okay.

Overrides: Interfaces.Platform.IPlatform.IPlatform.reset_platform

start_platform(self, configFile=None, interestList=None)


Configure the ASAM target for a SimWB test.

Extracts the target information via the simwbClient.getTarget() routine.
Connects to the target.
Validates the SimWB test configuration is appropriate for ASAM.
Gathers local configuration information and reconfigures SimWB for subsequent
  operations.

Part of the configuration information SimWB needs to know is exactly
which parameters will be captured during ASAM operations.  This information
can be defined two ways:
    configFile:    This is an XML file to be scanned for variable names
                   (and other XML file references)
    interestList:  This is a simple list of variable names.
Variable names are assumed to be Simulink parameter or signal names.
Regular SimWB RTDB variable names may also be used.

This function now executes a load_model() before returning. For backwards
compatibility, subsequent load_model() invocations will not do anything.

NOTE:
    * Both configFile and interestList may be used.

Overrides: Interfaces.Platform.IPlatform.IPlatform.start_platform

unpause_platform(self, sharedDictionary=None)

Resumes a paused test.

Resuming a running test is okay.

Overrides: Interfaces.Platform.IPlatform.IPlant.unpause_platform