timespec

  1# This file was automatically generated by SWIG (https://www.swig.org).
  2# Version 4.2.1
  3#
  4# Do not make changes to this file unless you know what you are doing - modify
  5# the SWIG interface file instead.
  6
  7from sys import version_info as _swig_python_version_info
  8from mock_rtems import _timespec as _timespec
  9
 10try:
 11    import builtins as __builtin__
 12except ImportError:
 13    import __builtin__
 14
 15def _swig_repr(self):
 16    try:
 17        strthis = "proxy of " + self.this.__repr__()
 18    except __builtin__.Exception:
 19        strthis = ""
 20    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
 21
 22
 23def _swig_setattr_nondynamic_instance_variable(set):
 24    def set_instance_attr(self, name, value):
 25        if name == "this":
 26            set(self, name, value)
 27        elif name == "thisown":
 28            self.this.own(value)
 29        elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
 30            set(self, name, value)
 31        else:
 32            raise AttributeError("You cannot add instance attributes to %s" % self)
 33    return set_instance_attr
 34
 35
 36def _swig_setattr_nondynamic_class_variable(set):
 37    def set_class_attr(cls, name, value):
 38        if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
 39            set(cls, name, value)
 40        else:
 41            raise AttributeError("You cannot add class attributes to %s" % cls)
 42    return set_class_attr
 43
 44
 45def _swig_add_metaclass(metaclass):
 46    """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
 47    def wrapper(cls):
 48        return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
 49    return wrapper
 50
 51
 52class _SwigNonDynamicMeta(type):
 53    """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
 54    __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
 55
 56
 57
 58def rtems_timespec_is_valid(time):
 59    r"""
 60    Is timespec valid
 61
 62    This method determines the validity of a timespec.
 63
 64    :type time: struct timespec, in
 65    :param time: is the timespec instance to validate.
 66    """
 67    return _timespec.rtems_timespec_is_valid(time)
 68
 69def rtems_timespec_less_than(lhs, rhs):
 70    r"""
 71    Timespec less than operator.
 72
 73    This method is the less than operator for timespecs.
 74
 75    :type lhs: struct timespec, in
 76    :param lhs: is the left hand side timespec
 77    :type rhs: struct timespec, in
 78    :param rhs: is the right hand side timespec
 79    """
 80    return _timespec.rtems_timespec_less_than(lhs, rhs)
 81
 82def rtems_timespec_add_to(time, add):
 83    r"""
 84    Add to a timespec.
 85
 86    This routine adds two timespecs.  The second argument is added
 87    to the first.
 88
 89    :type time: struct timespec, in
 90    :param time: is the base time to be added to
 91    :type add: struct timespec, in
 92    :param add: is the timespec to add to the first argument
 93
 94    :rtype: time_t
 95    :return: This method returns the number of seconds *time* increased by.
 96    """
 97    return _timespec.rtems_timespec_add_to(time, add)
 98
 99def rtems_timespec_to_ticks(time):
100    r"""
101    Convert timespec to number of ticks.
102
103    This routine convert the *time* timespec to the corresponding number
104    of clock ticks.
105
106    :type time: struct timespec, in
107    :param time: is the time to be converted
108
109    :rtype: uint32_t
110    :return: This method returns the number of ticks computed.
111    """
112    return _timespec.rtems_timespec_to_ticks(time)
113
114def rtems_timespec_from_ticks(ticks, time):
115    r"""
116    Convert ticks to timespec.
117
118    This routine converts the *ticks* value to the corresponding
119    timespec format *time*.
120
121    :type time: struct timespec, in
122    :param time: is the timespec format time result
123    :type ticks: uint32_t, in
124    :param ticks: is the number of ticks to convert
125    """
126    return _timespec.rtems_timespec_from_ticks(ticks, time)
127
128def rtems_timespec_subtract(start, end, result):
129    r"""
130    Subtract two timespec.
131
132    This routine subtracts two timespecs.  *result* is set to
133    *end* - *start*.
134
135    :type start: struct timespec, in
136    :param start: is the starting time
137    :type end: struct timespec, in
138    :param end: is the ending time
139    :type result: struct timespec, in
140    :param result: is the difference between starting and ending time.
141
142    :rtype: void
143    :return: This method fills in *result*.
144    """
145    return _timespec.rtems_timespec_subtract(start, end, result)
146
147def rtems_timespec_divide_by_integer(time, iterations, result):
148    r"""
149    Divide timespec by integer.
150
151    This routine divides a timespec by an integer value.  The expected
152    use is to assist in benchmark calculations where you typically
153    divide a duration by a number of iterations.
154
155    :type time: struct timespec, in
156    :param time: is the total
157    :type iterations: uint32_t, in
158    :param iterations: is the number of iterations
159    :type result: struct timespec, in
160    :param result: is the average time.
161
162    :rtype: void
163    :return: This method fills in *result*.
164    """
165    return _timespec.rtems_timespec_divide_by_integer(time, iterations, result)
166
167def rtems_timespec_divide(lhs, rhs, ival_percentage, fval_percentage):
168    r"""
169    Divide timespec.
170
171    This routine divides a timespec by another timespec.  The
172    intended use is for calculating percentages to three decimal points.
173
174    :type lhs: struct timespec, in
175    :param lhs: is the left hand number
176    :type rhs: struct timespec, in
177    :param rhs: is the right hand number
178    :type ival_percentage: uint32_t, in
179    :param ival_percentage: is the integer portion of the average
180    :type fval_percentage: uint32_t, in
181    :param fval_percentage: is the thousandths of percentage
182
183    :rtype: void
184    :return: This method fills in *result*.
185    """
186    return _timespec.rtems_timespec_divide(lhs, rhs, ival_percentage, fval_percentage)
187
188def rtems_timespec_set(_time, _seconds, _nanoseconds):
189    r"""
190    Set timespec to seconds nanosecond.
191
192    This method sets the timespec to the specified seconds and nanoseconds
193    value.
194
195    :type _time: struct timespec, in
196    :param _time: points to the timespec instance to validate.
197    :type _seconds: time_t, in
198    :param _seconds: is the seconds portion of the timespec
199    :type _nanoseconds: uint32_t, in
200    :param _nanoseconds: is the nanoseconds portion of the timespec
201    """
202    return _timespec.rtems_timespec_set(_time, _seconds, _nanoseconds)
203
204def rtems_timespec_zero(_time):
205    r"""
206    Zero timespec.
207
208    This method sets the timespec to zero.
209    value.
210
211    :type _time: struct timespec, in
212    :param _time: points to the timespec instance to zero.
213    """
214    return _timespec.rtems_timespec_zero(_time)
215
216def rtems_timespec_get_seconds(_time):
217    r"""
218    Get seconds portion of timespec.
219
220    This method returns the seconds portion of the specified timespec
221
222    :type _time: struct timespec, in
223    :param _time: points to the timespec
224
225    :rtype: time_t
226    :return: The seconds portion of *_time*.
227    """
228    return _timespec.rtems_timespec_get_seconds(_time)
229
230def rtems_timespec_get_nanoseconds(_time):
231    r"""
232    Get nanoseconds portion of timespec.
233
234    This method returns the nanoseconds portion of the specified timespec
235
236    :type _time: struct timespec, in
237    :param _time: points to the timespec
238
239    :rtype: uint32_t
240    :return: The nanoseconds portion of *_time*.
241    """
242    return _timespec.rtems_timespec_get_nanoseconds(_time)
243
244def rtems_timespec_greater_than(_lhs, _rhs):
245    r"""
246    Timespec greater than operator.
247
248    This method is the greater than operator for timespecs.
249
250    :type _lhs: struct timespec, in
251    :param _lhs: is the left hand side timespec
252    :type _rhs: struct timespec, in
253    :param _rhs: is the right hand side timespec
254    """
255    return _timespec.rtems_timespec_greater_than(_lhs, _rhs)
256
257def rtems_timespec_equal_to(lhs, rhs):
258    r"""
259    Timespec equal to Operator
260
261    This method is the is equal to than operator for timespecs.
262
263    :type lhs: struct timespec, in
264    :param lhs: is the left hand side timespec
265    :type rhs: struct timespec, in
266    :param rhs: is the right hand side timespec
267    """
268    return _timespec.rtems_timespec_equal_to(lhs, rhs)