[Artwork] / [QisMLib]

QisMLog

Welcome to the reference page for QisMLog, an extended API of QisMLib, Artwork Conversion's CAD processing framework.

QisMLog is the framework's shared logging service. Every part of the framework, and any extension or program built on it, can use it to report progress, warnings, and errors in one consistent way. Messages can go to the screen, to a log file, or to a handler in your own program, and you decide how much detail appears by setting a verbosity level or switching on named channels through environment variables, which are settings the operating system hands to a program when it starts.

The component also has a second, more unusual job: a vector log. Instead of writing text, it writes geometry, so a program can dump the shapes it is working on into a GDSII file, one of the standard formats for storing chip layouts, and open that file later in a viewer to see what happened.

This page is the complete reference for the component. Here is what you will find, in the order it appears:

If you are using the API into your own software, start with the main logging interface, and turn to the vector log when you need to see geometry rather than text.


QisMLog C++ API (qismlog.h)

Version Control

Cast to a pointer of another version in the class hierarchy (base/derived)

Grid

Get the file grid (in terms of file units)

Begin_cell

Begin a new cell definition for cellname

Boundary

BoundaryUU

Add a boundary to the vector log

Path

PathUU

Add a path to the vector log

Text

Add a text to the vector log

Sref

Add a single reference to a cell

Aref

Add an arrayed reference to a cell

End_cell

End the current cell definition

QisMLogChannels

Represents a manager of log channels

Version Control

Cast to a pointer of another version in the class hierarchy (base/derived)

Get_channel_onoff

Returns true if the specified channel is active and ON

Channel_msg

Send a message to a specific channel (cannot be NULL or empty)

Channel_str

Send a message to a specific channel (cannot be NULL or empty)

QisMLogCb

Client interface to receive log messages as callbacks (see QISM_ARG_LOGCB

Version Control

Cast to a pointer of another version in the class hierarchy (base/derived)

On_qismlog_msg

Callback for a single log message in response to QisMLog::Log_msg or QisMLog::Verbose_msg

QisMLog

API to write log messages (to stdout/stderr or a log file) throughout the QisMLib system.

Version Control

Cast to a pointer of another version in the class hierarchy (base/derived)

Log_msg

Write a message to screen (if enabled) and log file (if enabled) (multi-thread-safe)

Screen_msg

Write a message only to screen (if enabled) (multi-thread-safe)

Verbose_msg

Write a message to screen (if enabled) and log file (if enabled) only if the environment variable ACS_VERBOSE is set to ON (multi-thread-safe)

QisMLogV2

Unlink_log

Un-link/release the log. Any subsequent log messages will be ignored

Relink_log_file_path

Relink_log_file_ptr

Relink_log_client

Relink_stdout

Re-link the log with a file,file handle,client or stdout

Set_verbose_level

Verbose_msg_level

Write a log message if the verbose level is >= specified level

Log_str

Screen_str

Verbose_str

Write a pre-formatted string (msg) to the log

QisMLogV3

Channels

Get access to channel logs (if enabled by the env. var ACS_VERBOSE_CH)

QisMLogV4

Open_vector_log

Close_vector_log

Create/Destroy a log file (GDSII) to write vectors

QisMLog_debug_msg

Print messages to stderr ONLY from those compilation units where ACS_ASSERT_ON is defined


ARTWORK CONVERSION SOFTWARE, INC.
509 N. Sepulveda Blvd. Suite 201 Manhattan Beach, CA 90266  tel: 831.426.6163  email: info@artwork.surf

Last Updated -- Wed Sep 30 00:52:18 UTC 2026