Class IoLogInput

Defined in File IOApi.h

Inheritance Relationships

Base Type

public LogInput (Class LogInput)

Class Documentation

class IoLogInput : public LogInput 

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

Public Functions

IoLogInput()

virtual unsigned int GetModuleId(): Return the ModuleId of the Io 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

IOAddress inputIOAddress[constants::maxIoLogAddressSize]: An array with each index specifying one or more bits of contiguous input data of the I/O space. The byte and bit members specify the starting address, and the size member specifies the number of bits to log from the starting address. The input data to be logged are specified in the first inputSize indices of this array. If the same input bit is specified in more than one index of this array, the input bit will appear only once in the log file. Input bits will appear in the log file in ascending order of their address, regardless of the order that the input bit was specified in this array.

unsigned int inputSize: Specifies the indices of the inputIOAddress array that specifies input data to be logged. The maximum value that can be specified is maxIoLogAddressSize.

IOAddress outputIOAddress[constants::maxIoLogAddressSize]: An array with each index specifying one or more bits of contiguous output data of the I/O space. The byte and bit members specify the starting address, and the size member specifies the number of bits to log from the starting address. The output data to be logged are specified in the first outputSize indices of this array. If the same output bit is specified in more than one index of this array, the output bit will appear only once in the log file. Output bits will appear in the log file in ascending order of their address, regardless of the order that the output bit was specified in this array.

unsigned int outputSize: Specifies the indices of the outputIOAddress array that specifies output data to be logged. The maximum value that can be specified is maxIoLogAddressSize.

AIOFormat inputIOLogFormat[constants::maxIoLogFormatSize]: An array with each index specifying a contiguous segment of the input I/O space to be logged using a specific format. The size of the segment is determined by the specified aioFormatType. The input data to be logged are specified in the first inputIOFormatCount indices of this array.

unsigned int inputIOFormatCount: Specifies the indices of the inputIOLogFormat array that specifies the input data to be logged in specific formats. The maximum value that can be specified is maxIoLogFormatSize.

AIOFormat outputIOLogFormat[constants::maxIoLogFormatSize]: An array with each index specifying a contiguous segment of the output I/O space to be logged using a specific format. The size of the segment is determined by the specified aioFormatType. The output data to be logged are specified in the first outputIOFormatCount indices of this array.

unsigned int outputIOFormatCount: Specifies the indices of the outputIOLogFormat array that specifies the output data to be logged in specific formats. The maximum value that can be specified is maxIoLogFormatSize.