Class LogApiLogInput

Defined in File LogApi.h

Inheritance Relationships

Base Type

public LogInput (Class LogInput)

Class Documentation

class LogApiLogInput : public LogInput 

This class specifies the log data to be collected by the Log module.

Public Types

enum LogInputType

This enumerator contains the types of log data that can be collected.

Values:

enumerator CycleCounter: Collect the cycle counter data. This is the number of communication cycles that have elapsed since communication was started.

enumerator Time: Collect the time data. This is the amount of time that has elapsed since the engine was started. [microseconds]

Public Functions

LogApiLogInput()

LogApiLogInput(LogInputType type)

virtual unsigned int GetModuleId(): Return the ModuleId of the Log module.

virtual WMX3APIFUNC GetInputData(unsigned char *buff, int buffSize, unsigned int *dataSize)

Convert the values specified in other member variables of the class inheriting this class to a binary representation that can be sent to the engine.

Parameters:

buff – [out] A pointer to a buffer that will contain the binary representation of the member variables.
buffSize – [in] The size of the buffer in bytes.
dataSize – [out] A pointer to an unsigned int that will contain the size of the binary representation of the member variables, in bytes. This size of the buffer will be occupied.

virtual WMX3APIFUNC SetInputData(int moduleId, unsigned char *data, unsigned int dataSize)

Convert the binary representation of the values specified in other members of the class inheriting this class and copies them back to the other members.

Parameters:

moduleId – [in] The ID of the module that defines the binary representation of the member variables.
data – [in] A pointer to a buffer that contains the binary representation of the member variables.
dataSize – [in] The size of the buffer in bytes.

Public Members

LogInputType type: The type of log data to collect.