Quantum.IRunnerFactory Interface Reference

The interface for the runner factory. It creates platform specific objects to run the Quantum simulation. More...

Inheritance diagram for Quantum.IRunnerFactory:

Public Member Functions
IDeterministicGame	CreateGame (QuantumGameStartParameters startParameters)
	Instantiate an implementation of the IDeterministicGame. More...
void	CreateProfiler (string clientId, DeterministicSessionConfig deterministicConfig, DeterministicPlatformInfo platformInfo, IDeterministicGame game)
	The callback can be used to create and attach local profiler before the Quantum simulation has been started. More...
SessionRunner	CreateRunner (SessionRunner.Arguments arguments)
	Create an object that the SessionRunner is running on. For Unity it is wrapped in a MonoBehaviour. More...

Properties
DeterministicPlatformInfo	CreatePlaformInfo [get]
	Gather the platform information. There is a spelling mistake in the method name, but it's considered a bigger annoyance to change the interface. More...
TaskFactory	CreateTaskFactory [get]
	Create a Quantum task factory. More...
Action	UpdateDB [get]
	The action to when an update to the AssetDB is required. More...

Detailed Description

The interface for the runner factory. It creates platform specific objects to run the Quantum simulation.

Member Function Documentation

CreateProfiler()

void Quantum.IRunnerFactory.CreateProfiler	(	string	clientId,
		DeterministicSessionConfig	deterministicConfig,
		DeterministicPlatformInfo	platformInfo,
		IDeterministicGame	game
	)

The callback can be used to create and attach local profiler before the Quantum simulation has been started.

Parameters

clientId	Quantum client id
deterministicConfig	Session config
platformInfo	Platform info
game	Game

Implemented in Quantum.QuantumRunnerUnityFactory, and Quantum.DotNetRunnerFactory.

CreateGame()

IDeterministicGame Quantum.IRunnerFactory.CreateGame

(

QuantumGameStartParameters

startParameters

)

Instantiate an implementation of the IDeterministicGame.

Parameters

startParameters

Start parameters

Returns

Instance of IDeterministicGame

Implemented in Quantum.QuantumRunnerUnityFactory, and Quantum.DotNetRunnerFactory.

CreateRunner()

SessionRunner Quantum.IRunnerFactory.CreateRunner

(

SessionRunner.Arguments

arguments

)

Create an object that the SessionRunner is running on. For Unity it is wrapped in a MonoBehaviour.

Parameters

arguments

Session arguments

Returns

A session runner

Implemented in Quantum.QuantumRunnerUnityFactory, and Quantum.DotNetRunnerFactory.

Property Documentation

CreatePlaformInfo

DeterministicPlatformInfo Quantum.IRunnerFactory.CreatePlaformInfo

get

Gather the platform information. There is a spelling mistake in the method name, but it's considered a bigger annoyance to change the interface.

CreateTaskFactory

TaskFactory Quantum.IRunnerFactory.CreateTaskFactory

get

Create a Quantum task factory.

UpdateDB

Action Quantum.IRunnerFactory.UpdateDB

get

The action to when an update to the AssetDB is required.