Class MemoryLogStatus

Defined in File LogApi.h

Class Documentation

class MemoryLogStatus

This class contains the status of a memory log operation.

Public Functions

MemoryLogStatus()

Public Members

bool bufferOpened: If TRUE, the memory log buffer for this channel is opened. If FALSE, the memory log buffer for this channel is not opened.

LogState::T logState: The state of the memory logging operation.

unsigned int samplesToCollect: The total number of samples to be collected during the logging operation. [samples].

unsigned int samplesCollected: The number of samples that have been collected in the logging operation. [samples].

double usageRate: Contains the ratio of the amount of memory log buffer space occupied to the total amount of memory log buffer space. This value is between 0 and 1.

unsigned char overflowFlag: If this value is 1, overflow has occurred. If the amount of memory log buffer space occupied exceeds the total amount of memory log buffer space, overflow will occur and some log data will be lost. To prevent overflow, free the memory log buffer space by periodically reading data from it. If this value is 0, overflow has not occurred.

double interruptPeriod: The period of the interrupt (cyclic handler) that processes this memory log channel. [ms].