From 692394a5ee848dc549edaf30bf1ebe329876c3cf Mon Sep 17 00:00:00 2001 From: Joel Wetzell Date: Wed, 13 Sep 2023 20:54:11 -0500 Subject: [PATCH] try out jsdoc --- src/models/tracker.js | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/models/tracker.js b/src/models/tracker.js index 3f4323d..da63a7f 100644 --- a/src/models/tracker.js +++ b/src/models/tracker.js @@ -10,6 +10,11 @@ const infoTrackerChunk = require('../encoders/info/info-tracker-chunk'); const infoTrackerNameChunk = require('../encoders/info/info-tracker-name-chunk'); class Tracker { + /** + * @constructor + * @param {number} id - tracker id + * @param {string} name - tracker name + */ constructor(id, name) { this.id = id; this.name = name; @@ -22,30 +27,61 @@ class Tracker { this.timestamp = undefined; } + /** + * @param {float} x + * @param {float} y + * @param {float} z + */ setPos(x, y, z) { this.pos = [x, y, z]; } + /** + * @param {float} x + * @param {float} y + * @param {float} z + */ setSpeed(x, y, z) { this.speed = [x, y, z]; } + /** + * @param {float} x + * @param {float} y + * @param {float} z + */ setOri(x, y, z) { this.ori = [x, y, z]; } + /** + * @param {float} validity + */ setStatus(validity) { this.validity = validity; } + /** + * @param {float} x + * @param {float} y + * @param {float} z + */ setAccel(x, y, z) { this.accel = [x, y, z]; } + /** + * @param {float} x + * @param {float} y + * @param {float} z + */ setTrgtPos(x, y, z) { this.trgtpos = [x, y, z]; } + /** + * @param {BigInt} timestamp + */ setTimestamp(timestamp) { this.timestamp = timestamp; }