Simulation Class

The Simulation Class provides an interface to the Enterprise Architect Model Simulation facilities.

Simulation Attributes

Attribute

Description

See also

ObjectType

ObjectType

Notes: Read only

Distinguishes objects referenced through a Dispatch interface.

ObjectType

Speed

Long

Notes: Read/Write

Retrieve or set the current simulation running speed.

Run Model Simulation

Simulation Methods

Method

Description

See also

BroadcastSignal(string sSignalName,
string sParameters)

Boolean

Notes: Send a signal into the running simulation. If the simulation is stopped, do nothing.

Parameters:

  • sSignalName: String - the name of the signal OR the GUID of the Signal element
  • sParameters: String - a string of one or more signal parameters, in this format:

{parameter1: 5, parameter2: "test", parameter3: 3.2}

Dynamic Simulation with Javascript

IsSimulatorRunning()

Boolean

Notes: Check the state of the simulation.

Returns True if the simulation is running; returns False if the simulation is stopped.

Pause()

Boolean

Notes: Pause the simulation if it is running.

Run Model Simulation

Start()

Boolean

Notes: Start the simulation based on the current selection. If the current simulation is in a paused state, then the simulation is resumed.

StepIn()

Boolean

Notes: Step In to the routine in the current simulation.

StepOut()

Boolean

Notes: Step Out of the routine in the current simulation.

StepOver()

Boolean

Notes: Step Over the routine in the current simulation.

Stop()

Boolean

Notes: Stop the simulation.

Learn more