Kvaser CanKing GUI Extensions SDK - v7.3.0
    Preparing search index...

    Interface MessageLoggerSettings

    A message for defining a message logger's settings.

    interface MessageLoggerSettings {
        autoRestartAfterStop: boolean;
        canMessageFilter: CanMessageFilterSettings;
        colSeparator?: Separator;
        dataBytesConverterLimit?: number;
        decimalSeparator?: DecimalChar;
        fileConflictAction: FileConflictAction;
        fileFormat: LogFileFormat;
        fileName: string;
        numberOfTimeDecimals?: number;
        sizeLimit?: number;
        startTriggerSettings: TriggerSettings[];
        startTriggersOperator: TriggerOperator;
        stopTriggerSettings: TriggerSettings[];
        stopTriggersOperator: TriggerOperator;
        timeLimit?: number;
        timeReference?: TimeReference;
        useCalendarTime?: boolean;
        useUtcTime?: boolean;
        writeDataInHex?: boolean;
        writeFileHeader?: boolean;
        writeIdInHex?: boolean;
    }
    Index

    Properties

    autoRestartAfterStop canMessageFilter colSeparator? dataBytesConverterLimit? decimalSeparator? fileConflictAction fileFormat fileName numberOfTimeDecimals? sizeLimit? startTriggerSettings startTriggersOperator stopTriggerSettings stopTriggersOperator timeLimit? timeReference? useCalendarTime? useUtcTime? writeDataInHex? writeFileHeader? writeIdInHex?

    Properties

    autoRestartAfterStop: boolean

    A flag indicating if the logger should auto-restart after stop. Default value is false

    canMessageFilter: CanMessageFilterSettings

    Any filter

    colSeparator?: Separator

    The column separator to be used. Default value is a comma (,)

    dataBytesConverterLimit?: number

    Number of data bytes to max write to the log file (1-64). Default value is 8

    decimalSeparator?: DecimalChar

    The decimal separator to be used. Default value is a dot (.)

    fileConflictAction: FileConflictAction

    Name conflict action

    fileFormat: LogFileFormat

    The file format to be used

    fileName: string

    Name of the file to log messages to

    numberOfTimeDecimals?: number

    Number of time decimals (0-9). Default value is 9

    sizeLimit?: number

    Max file size in megabytes before writing to a new file

    startTriggerSettings: TriggerSettings[]

    Any start triggers

    startTriggersOperator: TriggerOperator

    The trigger operator to be used between start triggers

    stopTriggerSettings: TriggerSettings[]

    Any stop triggers

    stopTriggersOperator: TriggerOperator

    The trigger operator to be used between stop triggers

    timeLimit?: number

    Max number of seconds between first and last event before writing to a new file

    timeReference?: TimeReference

    Use the specified time reference. Default value is FIRST_TRIGGER

    useCalendarTime?: boolean

    Write timestamps in calendar time instead of seconds. Default value is false

    useUtcTime?: boolean

    Use UTC instead of local time for absolute timestamps. Default value is true

    writeDataInHex?: boolean

    Write data in hexadecimal format. Default value is true

    writeFileHeader?: boolean

    Write file header. Default value is true

    writeIdInHex?: boolean

    Write ID in hexadecimal format. Default value is true

    Settings

    Member Visibility

    On This Page

    Properties