[Artwork] / [QisMLib]

QisMFlow

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

QisMFlow is the framework's way of packaging application logic. The framework's ordinary programming interfaces are fine-grained: each call does one specific thing in memory. A flow sits one level up. It takes a set of command-line style arguments, runs a fixed sequence of those calls, and produces output, usually files on disk. In other words, a flow is a small command-line application that lives inside the framework or one of its extensions.

The payoff is that the same flow can be used two ways: launched from a terminal through the framework's flow runner program, or called directly from another program as if it were a function. Developers register their flows with the framework so they can be looked up by name.

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

If you are deciding whether to write a flow at all, read the introduction at the top of the page. If you are implementing one, start with the flow interface and then see the registry for how to make it discoverable.


QisMFlow C++ API (qismflow.h)

class QisMFlowUtil

Represents the engine (application) that is executing a flow

Version Control

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

Exec_dir()

Lib_handle()

Log_msg()

Log_str()

Send a message (or string) to the log (file/stdout)

Terminate_flow

Indicates that the flow needs to be terminated

class QisMFlow

Version Control

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

Run()

Execute the flow

Get_error_msg()

Get_error_tag()

Get_error_context()

Get the error information corresponding to a condition represented by ecode

Get_usage()

Returns the flow usage as a multi-line string

Get_version()

Returns the flow name and version as a single string

class QisMFlowRegister

Represents the registry of QisMLib flows

Version Control

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

Register_flow()

Add a flow identified by name and implemented by handle to the registry of flows

Get_flow()

Get the handle for the flow identified by name

List_flows()

Get a list of available flows as a string of names seperated by sep


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 01:16:58 UTC 2026