Syntalos::TimeSyncFileWriter

Syntalos::TimeSyncFileWriter

Write a timestamp synchronization file. More…

#include <tsyncfile.h>

Public Functions

Detailed Description

class Syntalos::TimeSyncFileWriter;

Write a timestamp synchronization file.

Helper class to write a timestamp synchronization file to adjust timestamps in a recording post-hoc. This is commonly used if the format data is stored in does not support timestamp adjustments, or as additional set of datapoints to ensure timestamps are really synchronized.

Public Functions Documentation

function TimeSyncFileWriter

explicit TimeSyncFileWriter()

function ~TimeSyncFileWriter

~TimeSyncFileWriter()

function TimeSyncFileWriter

TimeSyncFileWriter(
    const TimeSyncFileWriter & 
) =delete

function operator=

TimeSyncFileWriter & operator=(
    const TimeSyncFileWriter & 
) =delete

function lastError

std::string lastError() const

function hasError

bool hasError() const

Check whether a write error has occurred since the file was opened.

Write errors are sticky: once the underlying stream failed (e.g. because the disk is full), all subsequent writes are ignored and the file must be considered incomplete. The failure reason is available via lastError().

function setTimeNames

void setTimeNames(
    const std::string & time1Name,
    const std::string & time2Name
)

function setTimeUnits

void setTimeUnits(
    TSyncFileTimeUnit time1Unit,
    TSyncFileTimeUnit time2Unit
)

function setTimeDataTypes

void setTimeDataTypes(
    TSyncFileDataType time1DType,
    TSyncFileDataType time2DType
)

function fileName

std::string fileName() const

function setFileName

void setFileName(
    const std::string & fname
)

function setSyncMode

void setSyncMode(
    TSyncFileMode mode
)

function setChunkSize

void setChunkSize(
    int size
)

function setCreationTimeOverride

void setCreationTimeOverride(
    const std::chrono::system_clock::time_point & tp
)

function open

bool open(
    const std::string & modName,
    const Uuid & collectionId,
    const MetaStringMap & userData ={}
)

function open

bool open(
    const std::string & modName,
    const Uuid & collectionId,
    const microseconds_t & tolerance,
    const MetaStringMap & userData ={}
)

function flush

bool flush()

function close

bool close()

Finish writing and close the file.

Return: false if any data could not be written to disk, in which case the file is incomplete and lastError() describes the failure.

function writeTimes

void writeTimes(
    const microseconds_t & deviceTime,
    const microseconds_t & masterTime
)

function writeTimes

void writeTimes(
    const long long & timeIndex,
    const microseconds_t & masterTime
)

function writeTimes

void writeTimes(
    const long & time1,
    const long & time2
)

function writeTimes

void writeTimes(
    const uint64_t & time1,
    const uint64_t & time2
)

Updated on 2026-09-06 at 20:30:11 +0000