[babeltrace.git] / bindings / python / bt2 / bt2 / event_class.py

# The MIT License (MIT)
#
# Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

from bt2 import native_bt, object, utils
import bt2.field_types
import collections.abc
import bt2.values
import bt2.event
import copy
import bt2


class EventClassLogLevel:
    EMERGENCY = native_bt.EVENT_CLASS_LOG_LEVEL_EMERGENCY
    ALERT = native_bt.EVENT_CLASS_LOG_LEVEL_ALERT
    CRITICAL = native_bt.EVENT_CLASS_LOG_LEVEL_CRITICAL
    ERROR = native_bt.EVENT_CLASS_LOG_LEVEL_ERROR
    WARNING = native_bt.EVENT_CLASS_LOG_LEVEL_WARNING
    NOTICE = native_bt.EVENT_CLASS_LOG_LEVEL_NOTICE
    INFO = native_bt.EVENT_CLASS_LOG_LEVEL_INFO
    DEBUG_SYSTEM = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM
    DEBUG_PROGRAM = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM
    DEBUG_PROCESS = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS
    DEBUG_MODULE = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE
    DEBUG_UNIT = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT
    DEBUG_FUNCTION = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION
    DEBUG_LINE = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_LINE
    DEBUG = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG


class EventClass(object._Object):
    def __init__(self, name, id=None, log_level=None, emf_uri=None,
                 context_field_type=None, payload_field_type=None):
        utils._check_str(name)
        ptr = native_bt.event_class_create(name)

        if ptr is None:
            raise bt2.CreationError('cannot create event class object')

        super().__init__(ptr)

        if id is not None:
            self.id = id

        if log_level is not None:
            self.log_level = log_level

        if emf_uri is not None:
            self.emf_uri = emf_uri

        if context_field_type is not None:
            self.context_field_type = context_field_type

        if payload_field_type is not None:
            self.payload_field_type = payload_field_type

    @property
    def stream_class(self):
        sc_ptr = native_bt.event_class_get_stream_class(self._ptr)

        if sc_ptr is not None:
            return bt2.StreamClass._create_from_ptr(sc_ptr)

    @property
    def name(self):
        return native_bt.event_class_get_name(self._ptr)

    @property
    def id(self):
        id = native_bt.event_class_get_id(self._ptr)
        return id if id >= 0 else None

    @id.setter
    def id(self, id):
        utils._check_int64(id)
        ret = native_bt.event_class_set_id(self._ptr, id)
        utils._handle_ret(ret, "cannot set event class object's ID")

    @property
    def log_level(self):
        log_level = native_bt.event_class_get_log_level(self._ptr)
        return log_level if log_level >= 0 else None

    @log_level.setter
    def log_level(self, log_level):
        log_levels = (
            EventClassLogLevel.UNSPECIFIED,
            EventClassLogLevel.EMERGENCY,
            EventClassLogLevel.ALERT,
            EventClassLogLevel.CRITICAL,
            EventClassLogLevel.ERROR,
            EventClassLogLevel.WARNING,
            EventClassLogLevel.NOTICE,
            EventClassLogLevel.INFO,
            EventClassLogLevel.DEBUG_SYSTEM,
            EventClassLogLevel.DEBUG_PROGRAM,
            EventClassLogLevel.DEBUG_PROCESS,
            EventClassLogLevel.DEBUG_MODULE,
            EventClassLogLevel.DEBUG_UNIT,
            EventClassLogLevel.DEBUG_FUNCTION,
            EventClassLogLevel.DEBUG_LINE,
            EventClassLogLevel.DEBUG,
        )

        if log_level not in log_levels:
            raise ValueError("'{}' is not a valid log level".format(log_level))

        ret = native_bt.event_class_set_log_level(self._ptr, log_level)
        utils._handle_ret(ret, "cannot set event class object's log level")

    @property
    def emf_uri(self):
        return native_bt.event_class_get_emf_uri(self._ptr)

    @emf_uri.setter
    def emf_uri(self, emf_uri):
        utils._check_str(emf_uri)
        ret = native_bt.event_class_set_emf_uri(self._ptr, emf_uri)
        utils._handle_ret(ret, "cannot set event class object's EMF URI")

    @property
    def context_field_type(self):
        ft_ptr = native_bt.event_class_get_context_type(self._ptr)

        if ft_ptr is None:
            return

        return bt2.field_types._create_from_ptr(ft_ptr)

    @context_field_type.setter
    def context_field_type(self, context_field_type):
        context_field_type_ptr = None

        if context_field_type is not None:
            utils._check_type(context_field_type, bt2.field_types._FieldType)
            context_field_type_ptr = context_field_type._ptr

        ret = native_bt.event_class_set_context_type(self._ptr, context_field_type_ptr)
        utils._handle_ret(ret, "cannot set event class object's context field type")

    @property
    def payload_field_type(self):
        ft_ptr = native_bt.event_class_get_payload_type(self._ptr)

        if ft_ptr is None:
            return

        return bt2.field_types._create_from_ptr(ft_ptr)

    @payload_field_type.setter
    def payload_field_type(self, payload_field_type):
        payload_field_type_ptr = None

        if payload_field_type is not None:
            utils._check_type(payload_field_type, bt2.field_types._FieldType)
            payload_field_type_ptr = payload_field_type._ptr

        ret = native_bt.event_class_set_payload_type(self._ptr, payload_field_type_ptr)
        utils._handle_ret(ret, "cannot set event class object's payload field type")

    def __call__(self):
        event_ptr = native_bt.event_create(self._ptr)

        if event_ptr is None:
            raise bt2.CreationError('cannot create event field object')

        return bt2.event._create_from_ptr(event_ptr)

    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        self_props = (
            self.name,
            self.id,
            self.log_level,
            self.emf_uri,
            self.context_field_type,
            self.payload_field_type
        )
        other_props = (
            other.name,
            other.id,
            other.log_level,
            other.emf_uri,
            other.context_field_type,
            other.payload_field_type
        )
        return self_props == other_props

    def _copy(self, ft_copy_func):
        cpy = EventClass(self.name)
        cpy.id = self.id

        if self.log_level is not None:
            cpy.log_level = self.log_level

        if self.emf_uri is not None:
            cpy.emf_uri = self.emf_uri

        cpy.context_field_type = ft_copy_func(self.context_field_type)
        cpy.payload_field_type = ft_copy_func(self.payload_field_type)
        return cpy

    def __copy__(self):
        return self._copy(lambda ft: ft)

    def __deepcopy__(self, memo):
        cpy = self._copy(copy.deepcopy)
        memo[id(self)] = cpy
        return cpy
Commit	Line	Data
81447b5b PP	1	# The MIT License (MIT)
81447b5b PP	2	#
811644b8	3	# Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
81447b5b PP	4	#
	5	# Permission is hereby granted, free of charge, to any person obtaining a copy
	6	# of this software and associated documentation files (the "Software"), to deal
	7	# in the Software without restriction, including without limitation the rights
	8	# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	9	# copies of the Software, and to permit persons to whom the Software is
	10	# furnished to do so, subject to the following conditions:
	11	#
	12	# The above copyright notice and this permission notice shall be included in
	13	# all copies or substantial portions of the Software.
	14	#
	15	# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	18	# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	20	# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	21	# THE SOFTWARE.
	22
	23	from bt2 import native_bt, object, utils
	24	import bt2.field_types
	25	import collections.abc
	26	import bt2.values
	27	import bt2.event
	28	import copy
	29	import bt2
	30
	31
811644b8	32	class EventClassLogLevel:
50842bdc PP	33	EMERGENCY = native_bt.EVENT_CLASS_LOG_LEVEL_EMERGENCY
	34	ALERT = native_bt.EVENT_CLASS_LOG_LEVEL_ALERT
	35	CRITICAL = native_bt.EVENT_CLASS_LOG_LEVEL_CRITICAL
	36	ERROR = native_bt.EVENT_CLASS_LOG_LEVEL_ERROR
	37	WARNING = native_bt.EVENT_CLASS_LOG_LEVEL_WARNING
	38	NOTICE = native_bt.EVENT_CLASS_LOG_LEVEL_NOTICE
	39	INFO = native_bt.EVENT_CLASS_LOG_LEVEL_INFO
	40	DEBUG_SYSTEM = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM
	41	DEBUG_PROGRAM = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM
	42	DEBUG_PROCESS = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS
	43	DEBUG_MODULE = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE
	44	DEBUG_UNIT = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT
	45	DEBUG_FUNCTION = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION
	46	DEBUG_LINE = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_LINE
	47	DEBUG = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG
81447b5b PP	48
	49
	50	class EventClass(object._Object):
811644b8 PP	51	def __init__(self, name, id=None, log_level=None, emf_uri=None,
811644b8 PP	52	context_field_type=None, payload_field_type=None):
81447b5b	53	utils._check_str(name)
50842bdc	54	ptr = native_bt.event_class_create(name)
81447b5b PP	55
	56	if ptr is None:
	57	raise bt2.CreationError('cannot create event class object')
	58
	59	super().__init__(ptr)
	60
	61	if id is not None:
	62	self.id = id
	63
811644b8 PP	64	if log_level is not None:
	65	self.log_level = log_level
	66
	67	if emf_uri is not None:
	68	self.emf_uri = emf_uri
	69
81447b5b PP	70	if context_field_type is not None:
	71	self.context_field_type = context_field_type
	72
	73	if payload_field_type is not None:
	74	self.payload_field_type = payload_field_type
	75
81447b5b PP	76	@property
81447b5b PP	77	def stream_class(self):
50842bdc	78	sc_ptr = native_bt.event_class_get_stream_class(self._ptr)
81447b5b PP	79
	80	if sc_ptr is not None:
	81	return bt2.StreamClass._create_from_ptr(sc_ptr)
	82
81447b5b PP	83	@property
81447b5b PP	84	def name(self):
50842bdc	85	return native_bt.event_class_get_name(self._ptr)
81447b5b PP	86
	87	@property
	88	def id(self):
50842bdc	89	id = native_bt.event_class_get_id(self._ptr)
811644b8	90	return id if id >= 0 else None
81447b5b PP	91
	92	@id.setter
	93	def id(self, id):
	94	utils._check_int64(id)
50842bdc	95	ret = native_bt.event_class_set_id(self._ptr, id)
81447b5b PP	96	utils._handle_ret(ret, "cannot set event class object's ID")
81447b5b PP	97
811644b8 PP	98	@property
811644b8 PP	99	def log_level(self):
50842bdc	100	log_level = native_bt.event_class_get_log_level(self._ptr)
811644b8 PP	101	return log_level if log_level >= 0 else None
	102
	103	@log_level.setter
	104	def log_level(self, log_level):
	105	log_levels = (
	106	EventClassLogLevel.UNSPECIFIED,
	107	EventClassLogLevel.EMERGENCY,
	108	EventClassLogLevel.ALERT,
	109	EventClassLogLevel.CRITICAL,
	110	EventClassLogLevel.ERROR,
	111	EventClassLogLevel.WARNING,
	112	EventClassLogLevel.NOTICE,
	113	EventClassLogLevel.INFO,
	114	EventClassLogLevel.DEBUG_SYSTEM,
	115	EventClassLogLevel.DEBUG_PROGRAM,
	116	EventClassLogLevel.DEBUG_PROCESS,
	117	EventClassLogLevel.DEBUG_MODULE,
	118	EventClassLogLevel.DEBUG_UNIT,
	119	EventClassLogLevel.DEBUG_FUNCTION,
	120	EventClassLogLevel.DEBUG_LINE,
	121	EventClassLogLevel.DEBUG,
	122	)
	123
	124	if log_level not in log_levels:
	125	raise ValueError("'{}' is not a valid log level".format(log_level))
	126
50842bdc	127	ret = native_bt.event_class_set_log_level(self._ptr, log_level)
811644b8 PP	128	utils._handle_ret(ret, "cannot set event class object's log level")
	129
	130	@property
	131	def emf_uri(self):
50842bdc	132	return native_bt.event_class_get_emf_uri(self._ptr)
811644b8 PP	133
	134	@emf_uri.setter
	135	def emf_uri(self, emf_uri):
	136	utils._check_str(emf_uri)
50842bdc	137	ret = native_bt.event_class_set_emf_uri(self._ptr, emf_uri)
811644b8 PP	138	utils._handle_ret(ret, "cannot set event class object's EMF URI")
811644b8 PP	139
81447b5b PP	140	@property
81447b5b PP	141	def context_field_type(self):
50842bdc	142	ft_ptr = native_bt.event_class_get_context_type(self._ptr)
81447b5b PP	143
	144	if ft_ptr is None:
	145	return
	146
	147	return bt2.field_types._create_from_ptr(ft_ptr)
	148
	149	@context_field_type.setter
	150	def context_field_type(self, context_field_type):
	151	context_field_type_ptr = None
	152
	153	if context_field_type is not None:
	154	utils._check_type(context_field_type, bt2.field_types._FieldType)
	155	context_field_type_ptr = context_field_type._ptr
	156
50842bdc	157	ret = native_bt.event_class_set_context_type(self._ptr, context_field_type_ptr)
81447b5b PP	158	utils._handle_ret(ret, "cannot set event class object's context field type")
	159
	160	@property
	161	def payload_field_type(self):
50842bdc	162	ft_ptr = native_bt.event_class_get_payload_type(self._ptr)
81447b5b PP	163
	164	if ft_ptr is None:
	165	return
	166
	167	return bt2.field_types._create_from_ptr(ft_ptr)
	168
	169	@payload_field_type.setter
	170	def payload_field_type(self, payload_field_type):
	171	payload_field_type_ptr = None
	172
	173	if payload_field_type is not None:
	174	utils._check_type(payload_field_type, bt2.field_types._FieldType)
	175	payload_field_type_ptr = payload_field_type._ptr
	176
50842bdc	177	ret = native_bt.event_class_set_payload_type(self._ptr, payload_field_type_ptr)
81447b5b PP	178	utils._handle_ret(ret, "cannot set event class object's payload field type")
	179
	180	def __call__(self):
50842bdc	181	event_ptr = native_bt.event_create(self._ptr)
81447b5b PP	182
	183	if event_ptr is None:
	184	raise bt2.CreationError('cannot create event field object')
	185
	186	return bt2.event._create_from_ptr(event_ptr)
	187
	188	def __eq__(self, other):
	189	if type(other) is not type(self):
	190	return False
	191
	192	if self.addr == other.addr:
	193	return True
	194
81447b5b	195	self_props = (
81447b5b PP	196	self.name,
81447b5b PP	197	self.id,
811644b8 PP	198	self.log_level,
811644b8 PP	199	self.emf_uri,
81447b5b PP	200	self.context_field_type,
	201	self.payload_field_type
	202	)
	203	other_props = (
81447b5b PP	204	other.name,
81447b5b PP	205	other.id,
811644b8 PP	206	other.log_level,
811644b8 PP	207	other.emf_uri,
81447b5b PP	208	other.context_field_type,
	209	other.payload_field_type
	210	)
	211	return self_props == other_props
	212
	213	def _copy(self, ft_copy_func):
	214	cpy = EventClass(self.name)
	215	cpy.id = self.id
	216
811644b8 PP	217	if self.log_level is not None:
	218	cpy.log_level = self.log_level
	219
	220	if self.emf_uri is not None:
	221	cpy.emf_uri = self.emf_uri
81447b5b PP	222
	223	cpy.context_field_type = ft_copy_func(self.context_field_type)
	224	cpy.payload_field_type = ft_copy_func(self.payload_field_type)
	225	return cpy
	226
	227	def __copy__(self):
	228	return self._copy(lambda ft: ft)
	229
	230	def __deepcopy__(self, memo):
	231	cpy = self._copy(copy.deepcopy)
	232	memo[id(self)] = cpy
	233	return cpy