farm-ng-core
Public Member Functions | List of all members
core.events_file_writer.EventsFileWriter Class Reference

Public Member Functions

None __init__ (self, str|Path file_base, str extension=".bin", int max_file_mb=0)
 
EventsFileWriter __enter__ (self)
 
None __exit__ (self, object type, object value, object traceback)
 
str __repr__ (self)
 
int max_file_length (self)
 
int file_idx (self)
 
int file_length (self)
 
Path file_name (self)
 
bool is_open (self)
 
bool is_closed (self)
 
bool open (self)
 
bool close (self)
 
None write_event_payload (self, Event event, bytes payload)
 
None write (self, str path, Message message, list[Timestamp]|None timestamps=None, bool write_stamps=True)
 

Detailed Description

Write events to a file.

Constructor & Destructor Documentation

◆ __init__()

None core.events_file_writer.EventsFileWriter.__init__ (   self,
str | Path  file_base,
str   extension = ".bin",
int   max_file_mb = 0 
) 
Create a new EventsFileWriter.

Args:
    file_base: Path to and base of file name (without extension) where the events file will be logged.
    extension: Extension of the file to be logged. E.g., '.bin' or '.log'
    max_file_mb: Maximum log size in MB. Logging will roll over to new file when reached. Ignored if <= 0.

Member Function Documentation

◆ __enter__()

EventsFileWriter core.events_file_writer.EventsFileWriter.__enter__ (   self) 
Open the file for writing and return self.

◆ __exit__()

None core.events_file_writer.EventsFileWriter.__exit__ (   self,
object  type,
object  value,
object  traceback 
) 
Close the file.

◆ __repr__()

str core.events_file_writer.EventsFileWriter.__repr__ (   self) 
Return a string representation of this object.

◆ close()

bool core.events_file_writer.EventsFileWriter.close (   self) 
Close the file. Return True if successful.

◆ file_idx()

int core.events_file_writer.EventsFileWriter.file_idx (   self) 
Current file number for this logging session

◆ file_length()

int core.events_file_writer.EventsFileWriter.file_length (   self) 
Current file length, in bytes

◆ file_name()

Path core.events_file_writer.EventsFileWriter.file_name (   self) 
Current file name for this logging session

◆ is_closed()

bool core.events_file_writer.EventsFileWriter.is_closed (   self) 
Return True if the file is closed.

◆ is_open()

bool core.events_file_writer.EventsFileWriter.is_open (   self) 
Return True if the file is open.

◆ max_file_length()

int core.events_file_writer.EventsFileWriter.max_file_length (   self) 
Max file length, in bytes

◆ open()

bool core.events_file_writer.EventsFileWriter.open (   self) 
Open the file for writing. Return True if successful.

◆ write()

None core.events_file_writer.EventsFileWriter.write (   self,
str  path,
Message  message,
list[Timestamp] | None   timestamps = None,
bool   write_stamps = True 
) 
Write a message to the file.

Args:
    path: Path to the message.
    message: Message to write.
    timestamps: List of timestamps to write.
    write_stamps: If True, append FILE_WRITE timestamps to the event when writing.

◆ write_event_payload()

None core.events_file_writer.EventsFileWriter.write_event_payload (   self,
Event  event,
bytes  payload 
)
The documentation for this class was generated from the following file: