Structs, types, ...

Collaboration diagram for Structs, types, ...:

Macros
#define	MLPI_TRACE_MAIN_BUFFER_NAME   L"MAIN"
#define	MLPI_TRACE_KIS_CMD_BUFFER_NAME   L"KIS_CMD_LOGGER"
#define	MLPI_TRACE_MODULE_USER   L"MLPI_TRACE_USER"

Typedefs
typedef struct MlpiTraceModuleInformation	MlpiTraceModuleInformation
typedef struct MlpiTraceBufferInformation	MlpiTraceBufferInformation
typedef struct MlpiTraceMessage	MlpiTraceMessage

Enumerations

Detailed Description

List of used types, enumerations, structures and more...

Macro Definition Documentation

#define MLPI_TRACE_MAIN_BUFFER_NAME   L"MAIN"

Name of the main trace buffer which is always available.

Definition at line 230 of file mlpiTraceLib.h.

#define MLPI_TRACE_KIS_CMD_BUFFER_NAME   L"KIS_CMD_LOGGER"

Name of the kinematics trace buffer. This Buffer is used for tracing all kinematic user commands.

Definition at line 231 of file mlpiTraceLib.h.

#define MLPI_TRACE_MODULE_USER   L"MLPI_TRACE_USER"

Name of the module filter name of user.

Definition at line 233 of file mlpiTraceLib.h.

Typedef Documentation

MlpiTraceModuleInformation

This structure defines the information about a trace module as used by mlpiTraceGetModuleList.

Elements of struct MlpiTraceModuleInformation

Type	Element	Description
BOOL8	isActive	Is this module active? If not, all messages to it are ignored.
BOOL8	toStdOut	Is output to stdout enabled?
BOOL8	toMainBuffer	Is output to main buffer enabled?
BOOL8	toSeparateBuffer	Is output to separate trace buffer enabled?
WCHAR16[]	moduleName	Name of the module.
WCHAR16[]	bufferName	Name of optional separate buffer.

MlpiTraceBufferInformation

This structure defines the information about a trace buffer as used by mlpiTraceGetBufferList.

Elements of struct MlpiTraceBufferInformation

Type	Element	Description
WCHAR16[]	bufferName	Name of the buffer.
LONG	maximumBufferSize	Maximum number of messages to be stored in the buffer.
LONG	actualBufferSize	Actual number of messages in the buffer.
BOOL8	isLocked	Is this module locked? If true, all messages to it are ignored.

MlpiTraceMessage

This structure defines the information about a trace buffer as used by mlpiTraceReadBuffer.

Elements of struct MlpiTraceMessage

Type	Element	Description
ULLONG	index	Unique index of the message.
MlpiTraceType	type	Type of message (message, error, warning).
ULONG	milliseconds	Time in milliseconds when the message was sent.
ULONG	lineNumber	Line in the code in which trace message was sent.
ULONG	threadId	ID of thread in which trace message was sent.
WCHAR16[]	text	User message text given with trace message.
WCHAR16[]	moduleName	Module name of which the trace message was sent.
WCHAR16[]	functionName	Function name of which the trace message was sent.

Enumeration Type Documentation

enum MlpiTraceType

This enumeration defines the different types of entries that can be found in a trace buffer.

Enumerator
MLPI_TRACE_TYPE_OTHER	Unspecified message type.
MLPI_TRACE_TYPE_MESSAGE	Entry is log message.
MLPI_TRACE_TYPE_WARNING	Entry is warning.
MLPI_TRACE_TYPE_ERROR	Entry is error.

Definition at line 243 of file mlpiTraceLib.h.