captureimpl

  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 _captureimpl as _captureimpl
  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_capture_set_extension_index(index):
 59    r"""
 60    Capture set extension index.
 61
 62    This function is used to set the extension index
 63    for the capture engine.
 64
 65    :type index: int, in
 66    :param index: specifies the extension index to be
 67        used for capture engine data.
 68    """
 69    return _captureimpl.rtems_capture_set_extension_index(index)
 70
 71def rtems_capture_get_extension_index():
 72    r"""
 73    Capture get extension index.
 74
 75    This function rturns the extension index for the
 76    capture engine.
 77    """
 78    return _captureimpl.rtems_capture_get_extension_index()
 79
 80def rtems_capture_get_flags():
 81    r"""
 82    Capture get flags.
 83
 84    This function gets the current flag settings
 85    for the capture engine.
 86    """
 87    return _captureimpl.rtems_capture_get_flags()
 88
 89def rtems_capture_set_flags(mask):
 90    r"""
 91    Capture set flags.
 92
 93    This function sets a flag in the capture engine
 94
 95    :type mask: uint32_t, in
 96    :param mask: specifies the flag to set
 97    """
 98    return _captureimpl.rtems_capture_set_flags(mask)
 99
100def rtems_capture_user_extension_open():
101    r"""
102    Capture user extension open.
103
104    This function creates the capture user extensions.
105
106    """
107    return _captureimpl.rtems_capture_user_extension_open()
108
109def rtems_capture_user_extension_close():
110    r"""
111    Capture user extension close.
112
113    This function closes the capture user extensions.
114    """
115    return _captureimpl.rtems_capture_user_extension_close()
116
117def rtems_capture_trigger_fired(ft, tt, events):
118    r"""
119    Capture check trigger.
120
121    This function checks if we have triggered or if this event is a
122    cause of a trigger.
123
124    :type ft: rtems_tcb, in
125    :param ft: specifies specifices the capture from task
126    :type tt: rtems_tcb, in
127    :param tt: specifies specifices the capture to task
128    :type events: uint32_t, in
129    :param events: specifies the events
130    """
131    return _captureimpl.rtems_capture_trigger_fired(ft, tt, events)
132
133def rtems_capture_print_trace_records(total, csv):
134    r"""
135    Capture print trace records.
136
137    This function reads, prints and releases up to
138    total trace records in either a csv format or an
139    ascii table format.
140
141    :type total: int, in
142    :param total: specifies the number of records to print
143    :type csv: boolean, in
144    :param csv: specifies a comma seperated value format
145    """
146    return _captureimpl.rtems_capture_print_trace_records(total, csv)
147
148def rtems_capture_print_timestamp(uptime):
149    r"""
150    Capture print timestamp.
151
152    This function prints uptime in a timestamp format.
153
154    :type uptime: uint64_t, in
155    :param uptime: specifies the timestamp to print
156    """
157    return _captureimpl.rtems_capture_print_timestamp(uptime)
158
159def rtems_capture_print_record_task(cpu, rec, task_rec):
160    r"""
161    Capture print record task.
162
163    This function  prints a capture record task.  This
164    record contains information to identify a task.  It
165    is refrenced in other records by the task id.
166
167    :type cpu: int, in
168    :param cpu: specifies the cpu the cpu the record was logged on.
169    :type rec: rtems_capture_record, in
170    :param rec: specifies the task record.
171    """
172    return _captureimpl.rtems_capture_print_record_task(cpu, rec, task_rec)
173
174def rtems_capture_print_record_capture(cpu, rec, diff, name):
175    r"""
176    Capture print capture record.
177
178    This function prints a user extension
179    capture record.
180
181    :type cpu: int, in
182    :param cpu: specifies the cpu the cpu the record was logged on.
183    :type rec: rtems_capture_record, in
184    :param rec: specifies the record.
185    :type diff: uint64_t, in
186    :param diff: specifies the time between this and the last capture record.
187    :type name: rtems_name, in
188    :param name: specifies the name of the task, NULL if none.
189    :param task_count: number of tasks to search for.
190    """
191    return _captureimpl.rtems_capture_print_record_capture(cpu, rec, diff, name)
192
193def rtems_capture_print_watch_list():
194    r"""
195    Capture print watch list
196
197    This function  prints a capture watch list
198    """
199    return _captureimpl.rtems_capture_print_watch_list()
def rtems_capture_set_extension_index(index):
59def rtems_capture_set_extension_index(index):
60    r"""
61    Capture set extension index.
62
63    This function is used to set the extension index
64    for the capture engine.
65
66    :type index: int, in
67    :param index: specifies the extension index to be
68        used for capture engine data.
69    """
70    return _captureimpl.rtems_capture_set_extension_index(index)

Capture set extension index.

This function is used to set the extension index for the capture engine.

Parameters
  • index: specifies the extension index to be used for capture engine data.
def rtems_capture_get_extension_index():
72def rtems_capture_get_extension_index():
73    r"""
74    Capture get extension index.
75
76    This function rturns the extension index for the
77    capture engine.
78    """
79    return _captureimpl.rtems_capture_get_extension_index()

Capture get extension index.

This function rturns the extension index for the capture engine.

def rtems_capture_get_flags():
81def rtems_capture_get_flags():
82    r"""
83    Capture get flags.
84
85    This function gets the current flag settings
86    for the capture engine.
87    """
88    return _captureimpl.rtems_capture_get_flags()

Capture get flags.

This function gets the current flag settings for the capture engine.

def rtems_capture_set_flags(mask):
90def rtems_capture_set_flags(mask):
91    r"""
92    Capture set flags.
93
94    This function sets a flag in the capture engine
95
96    :type mask: uint32_t, in
97    :param mask: specifies the flag to set
98    """
99    return _captureimpl.rtems_capture_set_flags(mask)

Capture set flags.

This function sets a flag in the capture engine

Parameters
  • mask: specifies the flag to set
def rtems_capture_user_extension_open():
101def rtems_capture_user_extension_open():
102    r"""
103    Capture user extension open.
104
105    This function creates the capture user extensions.
106
107    """
108    return _captureimpl.rtems_capture_user_extension_open()

Capture user extension open.

This function creates the capture user extensions.

def rtems_capture_user_extension_close():
110def rtems_capture_user_extension_close():
111    r"""
112    Capture user extension close.
113
114    This function closes the capture user extensions.
115    """
116    return _captureimpl.rtems_capture_user_extension_close()

Capture user extension close.

This function closes the capture user extensions.

def rtems_capture_trigger_fired(ft, tt, events):
118def rtems_capture_trigger_fired(ft, tt, events):
119    r"""
120    Capture check trigger.
121
122    This function checks if we have triggered or if this event is a
123    cause of a trigger.
124
125    :type ft: rtems_tcb, in
126    :param ft: specifies specifices the capture from task
127    :type tt: rtems_tcb, in
128    :param tt: specifies specifices the capture to task
129    :type events: uint32_t, in
130    :param events: specifies the events
131    """
132    return _captureimpl.rtems_capture_trigger_fired(ft, tt, events)

Capture check trigger.

This function checks if we have triggered or if this event is a cause of a trigger.

Parameters
  • ft: specifies specifices the capture from task
  • tt: specifies specifices the capture to task
  • events: specifies the events
def rtems_capture_print_trace_records(total, csv):
134def rtems_capture_print_trace_records(total, csv):
135    r"""
136    Capture print trace records.
137
138    This function reads, prints and releases up to
139    total trace records in either a csv format or an
140    ascii table format.
141
142    :type total: int, in
143    :param total: specifies the number of records to print
144    :type csv: boolean, in
145    :param csv: specifies a comma seperated value format
146    """
147    return _captureimpl.rtems_capture_print_trace_records(total, csv)

Capture print trace records.

This function reads, prints and releases up to total trace records in either a csv format or an ascii table format.

Parameters
  • total: specifies the number of records to print
  • csv: specifies a comma seperated value format
def rtems_capture_print_timestamp(uptime):
149def rtems_capture_print_timestamp(uptime):
150    r"""
151    Capture print timestamp.
152
153    This function prints uptime in a timestamp format.
154
155    :type uptime: uint64_t, in
156    :param uptime: specifies the timestamp to print
157    """
158    return _captureimpl.rtems_capture_print_timestamp(uptime)

Capture print timestamp.

This function prints uptime in a timestamp format.

Parameters
  • uptime: specifies the timestamp to print
def rtems_capture_print_record_task(cpu, rec, task_rec):
160def rtems_capture_print_record_task(cpu, rec, task_rec):
161    r"""
162    Capture print record task.
163
164    This function  prints a capture record task.  This
165    record contains information to identify a task.  It
166    is refrenced in other records by the task id.
167
168    :type cpu: int, in
169    :param cpu: specifies the cpu the cpu the record was logged on.
170    :type rec: rtems_capture_record, in
171    :param rec: specifies the task record.
172    """
173    return _captureimpl.rtems_capture_print_record_task(cpu, rec, task_rec)

Capture print record task.

This function prints a capture record task. This record contains information to identify a task. It is refrenced in other records by the task id.

Parameters
  • cpu: specifies the cpu the cpu the record was logged on.
  • rec: specifies the task record.
def rtems_capture_print_record_capture(cpu, rec, diff, name):
175def rtems_capture_print_record_capture(cpu, rec, diff, name):
176    r"""
177    Capture print capture record.
178
179    This function prints a user extension
180    capture record.
181
182    :type cpu: int, in
183    :param cpu: specifies the cpu the cpu the record was logged on.
184    :type rec: rtems_capture_record, in
185    :param rec: specifies the record.
186    :type diff: uint64_t, in
187    :param diff: specifies the time between this and the last capture record.
188    :type name: rtems_name, in
189    :param name: specifies the name of the task, NULL if none.
190    :param task_count: number of tasks to search for.
191    """
192    return _captureimpl.rtems_capture_print_record_capture(cpu, rec, diff, name)

Capture print capture record.

This function prints a user extension capture record.

Parameters
  • cpu: specifies the cpu the cpu the record was logged on.
  • rec: specifies the record.
  • diff: specifies the time between this and the last capture record.
  • name: specifies the name of the task, NULL if none.
  • task_count: number of tasks to search for.
def rtems_capture_print_watch_list():
194def rtems_capture_print_watch_list():
195    r"""
196    Capture print watch list
197
198    This function  prints a capture watch list
199    """
200    return _captureimpl.rtems_capture_print_watch_list()

Capture print watch list

This function prints a capture watch list