14850939126

Committed 06 May 2025 03:22AM UTC coverage: 84.854% (-0.2%) from 85.076%

Build # 14850939126

Build Type

Pull #1119

github

Committed by

web-flow

Commit Message

Merge 235cb8c79 into eab439d5b

Pull Request Pull Request #1119: Disable methods not supported by humble

Coverage Stats

714 of 934 branches covered (76.45%)

Branch coverage included in aggregate %.

5 of 11 new or added lines in 2 files covered. (45.45%)

1751 of 1971 relevant lines covered (88.84%)

1100.94 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.36

/lib/timer.js

// Copyright (c) 2017 Intel Corporation. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

const rclnodejs = require('bindings')('rclnodejs');
const DistroUtils = require('./distro.js');

/**
 * @class - Class representing a Timer in ROS
 * @hideconstructor
 */

class Timer {
  constructor(handle, period, callback) {
    this._handle = handle;
    this._period = period;
    this.callback = callback;
  }

  /**
   * @type {bigint} - The period of the timer in nanoseconds.
   */
  get period() {
    return this._period;
  }

  get handle() {
    return this._handle;
  }

  /**
   * Check if the timer is ready.
   * @return {boolean} Return true if timer is ready, otherwise return false.
   */
  isReady() {
    return rclnodejs.isTimerReady(this._handle);
  }

  /**
   * Check if the timer is canceled.
   * @return {boolean} Return true if timer is canceled, otherwise return false.
   */
  isCanceled() {
    return rclnodejs.isTimerCanceled(this._handle);
  }

  /**
   * Cancel the timer.
   * @return {undefined}
   */
  cancel() {
    rclnodejs.cancelTimer(this._handle);
  }

  /**
   * Reset the timer.
   * @return {undefined}
   */
  reset() {
    rclnodejs.resetTimer(this._handle);
  }

  /**
   * Get the interval since the last call of this timer.
   * @return {bigint} - the interval value in nanoseconds.
   */
  timeSinceLastCall() {
    return rclnodejs.timerGetTimeSinceLastCall(this._handle);
  }

  /**
   * Get the interval until the next call will happen.
   * @return {bigint} - the interval value in nanoseconds.
   */
  timeUntilNextCall() {
    return rclnodejs.timerGetTimeUntilNextCall(this._handle);
  }

  /**
   * Change the timer period.
   * @param {bigint} period - The new period in nanoseconds.
   * @return {undefined}
   */
  changeTimerPeriod(period) {
    rclnodejs.changeTimerPeriod(this._handle, period);
  }

  /**
   * Get the timer period.
   * @return {bigint} - The period in nanoseconds.
   */
  get timerPeriod() {
    return rclnodejs.getTimerPeriod(this._handle);
  }

  /**
   * Call a timer and starts counting again, retrieves actual and expected call time.
   * @return {object} - The timer information.
   */
  callTimerWithInfo() {
    if (DistroUtils.getDistroId() <= DistroUtils.getDistroId('humble')) {
      console.warn(
        'callTimerWithInfo is not supported by this version of ROS 2'
      );
      return;
    }
    return rclnodejs.callTimerWithInfo(this._handle);
  }
}

module.exports = Timer;

1	// Copyright (c) 2017 Intel Corporation. All rights reserved.
2	//
3	// Licensed under the Apache License, Version 2.0 (the "License");
4	// you may not use this file except in compliance with the License.
5	// You may obtain a copy of the License at
6	//
7	// http://www.apache.org/licenses/LICENSE-2.0
8	//
9	// Unless required by applicable law or agreed to in writing, software
10	// distributed under the License is distributed on an "AS IS" BASIS,
11	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	// See the License for the specific language governing permissions and
13	// limitations under the License.
14
15	'use strict';
16
17	const rclnodejs = require('bindings')('rclnodejs');	78✔
18	const DistroUtils = require('./distro.js');	78✔
19
20	/**
21	* @class - Class representing a Timer in ROS
22	* @hideconstructor
23	*/
24
25	class Timer {
26	constructor(handle, period, callback) {
27	this._handle = handle;	168✔
28	this._period = period;	168✔
29	this.callback = callback;	168✔
30	}
31
32	/**
33	* @type {bigint} - The period of the timer in nanoseconds.
34	*/
35	get period() {
36	return this._period;	9✔
37	}
38
39	get handle() {
40	return this._handle;	27,697✔
41	}
42
43	/**
44	* Check if the timer is ready.
45	* @return {boolean} Return true if timer is ready, otherwise return false.
46	*/
47	isReady() {
48	return rclnodejs.isTimerReady(this._handle);	13,879✔
49	}
50
51	/**
52	* Check if the timer is canceled.
53	* @return {boolean} Return true if timer is canceled, otherwise return false.
54	*/
55	isCanceled() {
56	return rclnodejs.isTimerCanceled(this._handle);	9,024✔
57	}
58
59	/**
60	* Cancel the timer.
61	* @return {undefined}
62	*/
63	cancel() {
64	rclnodejs.cancelTimer(this._handle);	135✔
65	}
66
67	/**
68	* Reset the timer.
69	* @return {undefined}
70	*/
71	reset() {
72	rclnodejs.resetTimer(this._handle);	3✔
73	}
74
75	/**
76	* Get the interval since the last call of this timer.
77	* @return {bigint} - the interval value in nanoseconds.
78	*/
79	timeSinceLastCall() {
80	return rclnodejs.timerGetTimeSinceLastCall(this._handle);	3✔
81	}
82
83	/**
84	* Get the interval until the next call will happen.
85	* @return {bigint} - the interval value in nanoseconds.
86	*/
87	timeUntilNextCall() {
88	return rclnodejs.timerGetTimeUntilNextCall(this._handle);	3✔
89	}
90
91	/**
92	* Change the timer period.
93	* @param {bigint} period - The new period in nanoseconds.
94	* @return {undefined}
95	*/
96	changeTimerPeriod(period) {
97	rclnodejs.changeTimerPeriod(this._handle, period);	3✔
98	}
99
100	/**
101	* Get the timer period.
102	* @return {bigint} - The period in nanoseconds.
103	*/
104	get timerPeriod() {
105	return rclnodejs.getTimerPeriod(this._handle);	6✔
106	}
107
108	/**
109	* Call a timer and starts counting again, retrieves actual and expected call time.
110	* @return {object} - The timer information.
111	*/
112	callTimerWithInfo() {
113	if (DistroUtils.getDistroId() <= DistroUtils.getDistroId('humble')) {	3!
NEW 114	console.warn(	×
115	'callTimerWithInfo is not supported by this version of ROS 2'
116	);
NEW 117	return;	×
118	}
119	return rclnodejs.callTimerWithInfo(this._handle);	3✔
120	}
121	}
122
123	module.exports = Timer;	78✔

RobotWebTools / rclnodejs / 14850939126

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous