bt2: prepend `_` prefix to names of classes that the user cannot create

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

diff --git a/bindings/python/bt2/bt2/stream_class.py b/bindings/python/bt2/bt2/stream_class.py
index f2869cb98cd50f11fbfe0063ea6f242d78ae3390..54b5b38bba0587bf1f83e5ff9f3f44e549a32043 100644 (file)
--- a/bindings/python/bt2/bt2/stream_class.py
+++ b/bindings/python/bt2/bt2/stream_class.py
@@ -22,13 +22,13 @@
 
 from bt2 import native_bt, object, utils
 import bt2.field_class
+import bt2.event_class
 import collections.abc
-import bt2.ctf_writer
 import bt2.stream
 import bt2
 
 
-class StreamClass(object._SharedObject, collections.abc.Mapping):
+class _StreamClass(object._SharedObject, collections.abc.Mapping):
     _get_ref = staticmethod(native_bt.stream_class_get_ref)
     _put_ref = staticmethod(native_bt.stream_class_put_ref)
 
@@ -39,7 +39,7 @@ class StreamClass(object._SharedObject, collections.abc.Mapping):
         if ec_ptr is None:
             raise KeyError(key)
 
-        return bt2.EventClass._create_from_ptr_and_get_ref(ec_ptr)
+        return bt2.event_class._EventClass._create_from_ptr_and_get_ref(ec_ptr)
 
     def __len__(self):
         count = native_bt.stream_class_get_event_class_count(self._ptr)
@@ -61,17 +61,17 @@ class StreamClass(object._SharedObject, collections.abc.Mapping):
                            payload_field_class=None):
         if self.assigns_automatic_event_class_id:
             if id is not None:
-                raise bt2.CreationError('id provided, but stream class assigns automatic event class ids')
+                raise ValueError('id provided, but stream class assigns automatic event class ids')
 
             ec_ptr = native_bt.event_class_create(self._ptr)
         else:
             if id is None:
-                raise bt2.CreationError('id not provided, but stream class does not assign automatic event class ids')
+                raise ValueError('id not provided, but stream class does not assign automatic event class ids')
 
             utils._check_uint64(id)
             ec_ptr = native_bt.event_class_create_with_id(self._ptr, id)
 
-        event_class = bt2.event_class.EventClass._create_from_ptr(ec_ptr)
+        event_class = bt2.event_class._EventClass._create_from_ptr(ec_ptr)
 
         if name is not None:
             event_class._name = name
@@ -95,7 +95,7 @@ class StreamClass(object._SharedObject, collections.abc.Mapping):
         tc_ptr = native_bt.stream_class_borrow_trace_class_const(self._ptr)
 
         if tc_ptr is not None:
-            return bt2.TraceClass._create_from_ptr_and_get_ref(tc_ptr)
+            return bt2._TraceClass._create_from_ptr_and_get_ref(tc_ptr)
 
     @property
     def name(self):
@@ -129,24 +129,58 @@ class StreamClass(object._SharedObject, collections.abc.Mapping):
     _assigns_automatic_stream_id = property(fset=_assigns_automatic_stream_id)
 
     @property
-    def packets_have_default_beginning_clock_snapshot(self):
-        return native_bt.stream_class_packets_have_default_beginning_clock_snapshot(self._ptr)
+    def packets_have_beginning_default_clock_snapshot(self):
+        return native_bt.stream_class_packets_have_beginning_default_clock_snapshot(self._ptr)
 
-    def _packets_have_default_beginning_clock_snapshot(self, value):
+    def _packets_have_beginning_default_clock_snapshot(self, value):
         utils._check_bool(value)
-        native_bt.stream_class_set_packets_have_default_beginning_clock_snapshot(self._ptr, value)
+        native_bt.stream_class_set_packets_have_beginning_default_clock_snapshot(self._ptr, value)
 
-    _packets_have_default_beginning_clock_snapshot = property(fset=_packets_have_default_beginning_clock_snapshot)
+    _packets_have_beginning_default_clock_snapshot = property(fset=_packets_have_beginning_default_clock_snapshot)
 
     @property
-    def packets_have_default_end_clock_snapshot(self):
-        return native_bt.stream_class_packets_have_default_end_clock_snapshot(self._ptr)
+    def packets_have_end_default_clock_snapshot(self):
+        return native_bt.stream_class_packets_have_end_default_clock_snapshot(self._ptr)
 
-    def _packets_have_default_end_clock_snapshot(self, value):
+    def _packets_have_end_default_clock_snapshot(self, value):
         utils._check_bool(value)
-        native_bt.stream_class_set_packets_have_default_end_clock_snapshot(self._ptr, value)
+        native_bt.stream_class_set_packets_have_end_default_clock_snapshot(self._ptr, value)
 
-    _packets_have_default_end_clock_snapshot = property(fset=_packets_have_default_end_clock_snapshot)
+    _packets_have_end_default_clock_snapshot = property(fset=_packets_have_end_default_clock_snapshot)
+
+    @property
+    def supports_discarded_events(self):
+        return native_bt.stream_class_supports_discarded_events(self._ptr)
+
+    def _set_supports_discarded_events(self, supports, with_cs=False):
+        utils._check_bool(supports)
+        utils._check_bool(with_cs)
+
+        if not supports and with_cs:
+            raise ValueError('cannot not support discarded events, but have default clock snapshots')
+
+        native_bt.stream_class_set_supports_discarded_events(self._ptr, supports, with_cs)
+
+    @property
+    def discarded_events_have_default_clock_snapshots(self):
+        return native_bt.stream_class_discarded_events_have_default_clock_snapshots(self._ptr)
+
+    @property
+    def supports_discarded_packets(self):
+        return native_bt.stream_class_supports_discarded_packets(self._ptr)
+
+    def _set_supports_discarded_packets(self, supports, with_cs):
+        utils._check_bool(supports)
+        utils._check_bool(with_cs)
+
+        if not supports and with_cs:
+            raise ValueError('cannot not support discarded packets, but have default clock snapshots')
+
+        native_bt.stream_class_set_supports_discarded_packets(self._ptr, supports, with_cs)
+
+    @property
+    def discarded_packets_have_default_clock_snapshots(self):
+        return native_bt.stream_class_discarded_packets_have_default_clock_snapshots(self._ptr)
 
     @property
     def id(self):
@@ -163,21 +197,6 @@ class StreamClass(object._SharedObject, collections.abc.Mapping):
         ret = native_bt.stream_class_set_id(self._ptr, id)
         utils._handle_ret(ret, "cannot set stream class object's ID")
 
-    @property
-    def clock(self):
-        clock_ptr = native_bt.stream_class_get_clock(self._ptr)
-
-        if clock_ptr is None:
-            return
-
-        return bt2.ctf_writer.CtfWriterClock._create_from_ptr(clock_ptr)
-
-    @clock.setter
-    def clock(self, clock):
-        utils._check_type(clock, bt2.ctf_writer.CtfWriterClock)
-        ret = native_bt.stream_class_set_clock(self._ptr, clock._ptr)
-        utils._handle_ret(ret, "cannot set stream class object's CTF writer clock object")
-
     @property
     def packet_context_field_class(self):
         fc_ptr = native_bt.stream_class_borrow_packet_context_field_class_const(self._ptr)