Syntalos::TimeSyncFileWriter

Syntalos::TimeSyncFileWriter

Syntalos::TimeSyncFileWriter

Write a timestamp synchronization file. More…

#include <tsyncfile.h>

Public Functions

Name
TimeSyncFileWriter()
~TimeSyncFileWriter()
QStringlastError() const
voidsetTimeNames(const QString & time1Name, const QString & time2Name)
voidsetTimeUnits(TSyncFileTimeUnit time1Unit, TSyncFileTimeUnit time2Unit)
voidsetTimeDataTypes(TSyncFileDataType time1DType, TSyncFileDataType time2DType)
QStringfileName() const
voidsetFileName(const QString & fname)
voidsetSyncMode(TSyncFileMode mode)
voidsetChunkSize(int size)
voidsetCreationTimeOverride(const QDateTime & dt)
boolopen(const QString & modName, const QUuid & collectionId, const QVariantHash & userData =QVariantHash())
boolopen(const QString & modName, const QUuid & collectionId, const microseconds_t & tolerance, const QVariantHash & userData =QVariantHash())
voidflush()
voidclose()
voidwriteTimes(const microseconds_t & deviceTime, const microseconds_t & masterTime)
voidwriteTimes(const long long & timeIndex, const microseconds_t & masterTime)
voidwriteTimes(const long & time1, const long & time2)
voidwriteTimes(const uint64_t & time1, const uint64_t & time2)

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 lastError

QString lastError() const

function setTimeNames

void setTimeNames(
    const QString & time1Name,
    const QString & time2Name
)

function setTimeUnits

void setTimeUnits(
    TSyncFileTimeUnit time1Unit,
    TSyncFileTimeUnit time2Unit
)

function setTimeDataTypes

void setTimeDataTypes(
    TSyncFileDataType time1DType,
    TSyncFileDataType time2DType
)

function fileName

QString fileName() const

function setFileName

void setFileName(
    const QString & fname
)

function setSyncMode

void setSyncMode(
    TSyncFileMode mode
)

function setChunkSize

void setChunkSize(
    int size
)

function setCreationTimeOverride

void setCreationTimeOverride(
    const QDateTime & dt
)

function open

bool open(
    const QString & modName,
    const QUuid & collectionId,
    const QVariantHash & userData =QVariantHash()
)

function open

bool open(
    const QString & modName,
    const QUuid & collectionId,
    const microseconds_t & tolerance,
    const QVariantHash & userData =QVariantHash()
)

function flush

void flush()

function close

void close()

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 2024-11-06 at 17:10:29 +0000