Class AgvIdMap<T>

Maps AGV identifiers to values of a given value type.

An AgvIdMap object iterates its elements in insertion order; a for-of loop returns an array of [agvId, value] for each iteration.

Type Parameters

T

Hierarchy

AgvIdMap

Index

Constructors

Accessors

Methods

[iterator] clear delete get set

Constructors

constructor

new AgvIdMap<T>(): AgvIdMap<T>
Type Parameters
- T
Returns AgvIdMap<T>

Accessors

size

get size(): number
Gets the number of AgvId - value associations.

Returns
total number of values in the map

Returns number
- Defined in common/agvid-map.ts:22

Methods

[iterator]

[iterator](): Generator<[AgvId, T], void, unknown>
Returns Generator<[AgvId, T], void, unknown>
- Defined in common/agvid-map.ts:80

clear

clear(): void
Clears all values of the AGV map.

Returns void
- Defined in common/agvid-map.ts:76

delete

delete(agvId: AgvId): void
Deletes the value associated with the given AGV identifier.
Parameters
- agvId: AgvId
  
  an AGV identifier
Returns void
- Defined in common/agvid-map.ts:62

get

get(agvId: AgvId): T
Gets the value associated with the given AGV identifier.

Returns
associated value or undefined if not existing
Parameters
- agvId: AgvId
  
  an AGV identifier
Returns T
- Defined in common/agvid-map.ts:34

set

set(agvId: AgvId, value: T): void
Associates the given value with the given AGV identifier.
Parameters
- agvId: AgvId
  
  an AGV identifier
- value: T
  
  value to be associated
Returns void
- Defined in common/agvid-map.ts:48

Generated using TypeDoc