Class: GNSSPublisher
A publisher for global positioning and inertial data.
Hierarchy
↳
GNSSPublisher
Constructors
constructor
• new GNSSPublisher(bus
, pacer?
): GNSSPublisher
Create an GNSSPublisher
Parameters
Name | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The EventBus to publish to |
pacer | undefined | PublishPacer <GNSSEvents > | undefined | An optional pacer to use to control the rate of publishing |
Returns
Overrides
Defined in
src/sdk/instruments/GNSS.ts:99
Properties
bus
• Protected
Readonly
bus: EventBus
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:10
pacer
• Protected
Readonly
pacer: undefined
| PublishPacer
<GNSSEvents
>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:13
publishActive
• Protected
publishActive: boolean
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:12
publisher
• Protected
Readonly
publisher: Publisher
<GNSSEvents
>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:11
Methods
isPublishing
▸ isPublishing(): boolean
Tells whether or not the publisher is currently active.
Returns
boolean
True if the publisher is active, false otherwise.
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:45
onUpdate
▸ onUpdate(): void
A callback called when the publisher receives an update cycle.
Returns
void
Overrides
Defined in
src/sdk/instruments/GNSS.ts:160
publish
▸ publish<K
>(topic
, data
, sync?
, isCached?
): void
Publish a message if publishing is acpive
Type parameters
Name | Type |
---|---|
K | extends keyof GNSSEvents |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | GNSSEvents [K ] | undefined | The data type for chosen topic. |
sync | boolean | false | Whether or not the event should be synced to other instruments. Defaults to false . |
isCached | boolean | true | Whether or not the event should be cached. Defaults to true . |
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:63
startPublish
▸ startPublish(): void
Start publishing.
Returns
void
Overrides
Defined in
src/sdk/instruments/GNSS.ts:146
stopPublish
▸ stopPublish(): void
Stop publishing.
Returns
void
Overrides
Defined in
src/sdk/instruments/GNSS.ts:153
getInstantaneousTrack
▸ getInstantaneousTrack(headingTrue?
): number
Gets the instantaneous true track.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
headingTrue | number | 0 | The true heading, in degrees. |
Returns
number
The true track, in degrees.
Defined in
src/sdk/instruments/GNSS.ts:263