Class FecItem

Represents a simulation event scheduled for future execution.

Hierarchy

FecItem

Index

Constructors

constructor

Accessors

Methods

dispatch

Constructors

constructor

new FecItem(e: Entity<Simulation>, options: IFecItemOptions): FecItem

- Defined in simulation.ts:725
Initializes a new instance of a FecItem object.

Parameters
- e: Entity<Simulation>
  
  Entity that the item refers to.
- options: IFecItemOptions
  
  IFecItemOptions used to initialize the object.
Returns FecItem

Accessors

e

get e(): Entity<Simulation>

- Defined in simulation.ts:766
Gets a reference to the Entity that this item refers to.

Returns Entity<Simulation>

options

get options(): IFecItemOptions

- Defined in simulation.ts:772
Gets the {@see IFecItemOptions} assigned to this item.

Returns IFecItemOptions

promise

get promise(): Promise<number>

- Defined in simulation.ts:834
Gets the Promise represented by this item.

Returns Promise<number>

ready

get ready(): boolean
set ready(value: boolean): void

- Defined in simulation.ts:779
Gets or sets a value that determines if this item is ready to resume execution.

Returns boolean
- Defined in simulation.ts:800
Gets or sets a value that determines if this item is ready to resume execution.

Parameters
- value: boolean
Returns void

timeDue

get timeDue(): number

- Defined in simulation.ts:812
Gets the simulated time when this item is due to resume execution.

Returns number

timeStart

get timeStart(): number

- Defined in simulation.ts:806
Gets the simulated time when this item was created.

Returns number

Methods

dispatch

dispatch(): Promise<any>

- Defined in simulation.ts:819
Dispatches the Entity so it resumes execution of its Entity.script function.

Returns Promise<any>

Generated using TypeDoc