Skip to content

Commit

Permalink
Add comments to mark API as unstable.
Browse files Browse the repository at this point in the history
  • Loading branch information
KerstinKeller committed Jan 31, 2024
1 parent b66b5ea commit 6259737
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions lang/python/ecalhdf5/ecal/measurement/writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ def combine_encoding_and_type(encoding, type):
return encoding + ":" + type

class ProtobufChannelWriter:
"""Class to create Protobuf Channels
This API is not considered stable and might break in future eCAL Versions
"""

def __init__(self, channel_name: str, protobuf_type, meas: ecalhdf5.Meas):
self._protobuf_type = protobuf_type
self._binary_writer = BinaryChannelWriter(channel_name, meas=meas, encoding = self.encoding, type = self.type, descriptor = self.descriptor)
Expand All @@ -50,6 +55,11 @@ def type(self):
return self._protobuf_type.DESCRIPTOR.full_name

class BinaryChannelWriter:
"""Class to create Binary Channels
This API is not considered stable and might break in future eCAL Versions
"""

def __init__(self, channel_name: str, meas: ecalhdf5.Meas, encoding = "", type = "", descriptor = ""):
self._meas = meas
self._channel_name = channel_name
Expand Down Expand Up @@ -85,6 +95,11 @@ class Encoding(Enum):
PROTOBUF = 1

class MeasurementWriter:
"""Write an eCAL Measurement
This API is not considered stable and might break in future eCAL Versions
"""

def __init__(self, output_dir: str, file_name: str, max_size_per_file: int):
self._output_dir = output_dir
self._file_name = file_name
Expand Down

0 comments on commit 6259737

Please sign in to comment.