LogThat on Loupe Documentation

Usage

Mon, 01 Jan 0001 00:00:00 +0000

Short snippets on this page show only the LogThat calls. Longer ones are written inside the routine they belong in. Where a snippet shows its rendered output in a comment, the values it prints are declared so the result can be checked; other application variables are left undeclared.

Installation

Install with the Loupe Package Manager:

lpm install logthat

LogThat depends on ArEventLog and AsBrStr, which ship with Automation Studio, and on Loupe’s StringExt library. If StringExt is not already in the project, install it as well:

Functions

Mon, 01 Jan 0001 00:00:00 +0000

Short snippets on this page show only the LogThat calls; longer ones are written inside the routine they belong in. Application variables are left undeclared unless a rendered output comment depends on them. Snippets that write a log entry from a cyclic body are guarded on an edge flag, because a log entry is a one-shot event. The function blocks are different: logStateChange and logDelete are called every scan by design, and do their own edge or completion handling.

Structures

Mon, 01 Jan 0001 00:00:00 +0000

StrExtArgs_typ

Format arguments for a log message. This type comes from StringExt and is passed to the log functions by address through pMsgData. Each format specifier in the message consumes the next unused member of the matching type, in order.

Name	Type	Description
r	ARRAY[0..4] OF REAL	Values for `%r` and `%f`
s	ARRAY[0..4] OF UDINT	Addresses of strings for `%s`
b	ARRAY[0..4] OF BOOL	Values for `%b`
i	ARRAY[0..4] OF DINT	Values for `%i` and `%d`

Application variables are left undeclared in this snippet. The call is guarded on an edge flag because a log entry is a one-shot event, not something to write every scan.