Class LogOutput

Defined in File WMX3Api.h

Inheritance Relationships

Derived Types

public CoreMotionLogOutput (Class CoreMotionLogOutput)
public EcLogOutput (Class EcLogOutput)
public IoLogOutput (Class IoLogOutput)
public LogApiLogOutput (Class LogApiLogOutput)
public UserMemoryLogOutput (Class UserMemoryLogOutput)

Class Documentation

class LogOutput

This virtual class defines the interface of the log data to collect. Each module that supports the collection of log data will define a class that inherits this class.

Subclassed by CoreMotionLogOutput, EcLogOutput, IoLogOutput, LogApiLogOutput, UserMemoryLogOutput

Public Functions

LogOutput()

virtual unsigned int GetModuleId() = 0

Return the ID of the module to collect the log data.

virtual WMX3APIFUNC SetOutputData(int moduleId, unsigned char *cfgData, unsigned int cfgDataSize, unsigned char *data, unsigned int dataSize, unsigned int dataIndex, unsigned int storeIndex) = 0

Reads the two binary representations of the input as the settings of the log data to be retrieved and the values of the member variables contained in the derived class of this class. Assign the value of the read member variable to each member variable of the derived class that called this function, according to the setting that was read.

Parameters:

moduleId – [in] ID number of the module that defines how to read the binary representation.
cfgData – [in] A pointer to the buffer that the settings of the log data to be retrieved are contained as a binary representation.
cfgDataSize – [in] The size of the buffer that the settings of the log data to be retrieved are contained as a binary representation. The units are bytes.
data – [in] A pointer to the buffer that the values of the member variables are contained as a binary representation.
dataSize – [in] The size of the buffer that the values of the member variables are contained as a binary representation. The units are bytes.
dataIndex – [in] The index of the buffer that the values of the member variables are contained as a binary representation.
storeIndex – [in] The index to store the value of the member variable that read.

Public Members

unsigned int count: The number of cycles of data that have been logged.

unsigned char overflowFlag: If set to 1, some data that have not yet been retrieved by the GetMemoryLogData function have been discarded, because the buffer memory storing the memory log data ran out of space. If set to 0, there was no overflow error.

long long cycleCounter[constants::maxLogOutputDataSize]: The cycle counter of the cycle that the data is from. The cycle counter increments by 1 each communication cycle. The first “count” indices of this array contains logged data. The data is contained in the elements of the number of values of the “count” variable from the top of the array.