Class UserMemoryLogInput

Defined in File UserMemoryApi.h

Inheritance Relationships

Base Type

public LogInput (Class LogInput)

Class Documentation

class UserMemoryLogInput : public LogInput 

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

Public Functions

UserMemoryLogInput()

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

MAddress mAddress[constants::maxUserMemoryLogAddressSize]: An array with each index specifying one or more contiguous bits of the user memory 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 user memory data to be logged are specified in the first mAddressSize indices of this array. If the same user memory bit is specified in more than one index of this array, the user memory bit will appear only once in the log file. User memory bits will appear in the log file in ascending order of their address, regardless of the order that the user memory bit was specified in this array.

unsigned int mAddressSize: Specifies the indices of the mAddress array that specifies user memory data to be logged. The maximum value that can be specified is maxUserMemoryLogAddressSize.

AIOFormat mLogFormat[constants::maxUserMemoryLogFormatSize]: An array with each index specifying a contiguous segment of the user memory space to be logged using a specific format. The size of the segment is determined by the specified aioFormatType. The user memory data to be logged are specified in the first mFormatCount indices of this array.

unsigned int mFormatCount: Specifies the indices of the mLogFormat array that specifies the user memory data to be logged in specific formats. The maximum value that can be specified is maxUserMemoryLogFormatSize.