Class: Micrometer

Defined in: drivers/micrometer/index.ts:15

Micrometer driver for the optical micrometer tools, extends the MultipleFeed class

Extends

• MultipleFeed

Constructors

Constructor

new Micrometer(log, options): Micrometer;

Defined in: drivers/micrometer/index.ts:24

Parameters

Parameter	Type
log	any
options	IKeyValue

Returns

Micrometer

Overrides

MultipleFeed.constructor

Properties

Property	Modifier	Type	Default value	Description	Defined in
mediaStream	public	MediaStream	undefined	-	drivers/micrometer/index.ts:22
toolName	static	string	'Optical Micrometer'	The tool's name: Optical Micrometer	drivers/micrometer/index.ts:20
userClass	static	string	'OpticalMicrometer-v1'	Type of tool: OpticalMicrometer-v1	drivers/micrometer/index.ts:17

Methods

blocking()

blocking(): Promise<any>;

Defined in: drivers/MultipleFeed.ts:103

Creates a promise to await when the driver completes its run

Returns

Promise<any>

A promise for all the feeds

Inherited from

MultipleFeed.blocking

---

start()

start(): Promise<void>;

Defined in: drivers/MultipleFeed.ts:62

Starts the multiple feed driver

Returns

Promise<void>

Inherited from

MultipleFeed.start

---

stop()

stop(reason): void;

Defined in: drivers/MultipleFeed.ts:75

Stops the driver and all of the feeds associated with it

Parameters

Parameter	Type	Description
reason	string	Reason for stopping the driver

Returns

void

Inherited from

MultipleFeed.stop