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:
The engine interface. What a running flow can ask of the program that is executing it: where the framework library lives on disk, a handle to the framework itself, a way to write ordinary and error messages to the log, and a signal the flow must check periodically to see whether it has been asked to stop.
The flow interface. What every flow must provide: a run routine that accepts the arguments and returns a success or error code, lookups that turn an error code into a message, a tag, and context, a usage text, and a name-and-version string.
The flow registry. How flows are added to the framework's registry by name, retrieved by name, and listed as a separated string of names.
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 QisMFlow C++ API (qismflow.h)class QisMFlowUtilVersion ControlExec_dir()Lib_handle()Log_msg()Log_str()Terminate_flowclass QisMFlowVersion ControlRun()Get_error_msg()Get_error_tag()Get_error_context()Get_usage()Get_version()class QisMFlowRegisterVersion ControlRegister_flow()Get_flow()List_flows()
class QisMFlowUtil { ... };Represents the engine (application) that is executing a flow
Cast to a pointer of another version in the class hierarchy (base/derived)
Get the latest version number. Version numbers start at 1 and are reflected in the class name using the suffix V<number>. E.g <baseclass>V<version>
The topmost base class is version 1 (V1 implied)
The cast returns NULL if a version number is not recognized/implemented
xxxxxxxxxxvirtual void* QisMFlowUtil_cast(const int version) = 0;virtual const void* QisMFlowUtil_cast(const int version) const = 0;virtual int QisMFlowUtil_latest_version() const = 0;Returns the location of qismlib64.dll/libqism64.so
xxxxxxxxxxvirtual const char* Exec_dir() const = 0;Returns the handle to QisMLib
xxxxxxxxxxvirtual QisMLib* Lib_handle() = 0;Send a message (or string) to the log (file/stdout)
err is true if the message represents an error/warning (stderr)
fmt is the format string (same as printf)
str is a pre-formatted string
New-lines are not added automatically. They MUST be added explicitly in the fmt or str
xxxxxxxxxxvirtual void Log_msg(const bool err, const char* fmt, ...) = 0;virtual void Log_str(const bool err, const char* str) = 0;Indicates that the flow needs to be terminated
The flow implementation MUST periodically check this and if return != 0, gracefully return out of Run
Return of 0 implies continue flow, !=0 implies terminate
xxxxxxxxxxvirtual int Terminate_flow() = 0;xxxxxxxxxxclass QisMFlow: public QisMExtensionAPI { ... };Represents a flow registered with QisMLib
Cast to a pointer of another version in the class hierarchy (base/derived)
Get the latest version number. Version numbers start at 1 and are reflected in the class name using the suffix V<number>. E.g <baseclass>V<version>
The topmost base class is version 1 (V1 implied)
The cast returns NULL if a version number is not recognized/implemented
xxxxxxxxxxvirtual void* QisMFlow_cast(const int version) = 0;virtual const void* QisMFlow_cast(const int version) const = 0;virtual int QisMFlow_latest_version() const = 0;Execute the flow
util represents the engine that is executing this flow
argc, argv are the list of command-line style parameters relevant to this flow
Returns 0 on success. Otherwise use Get_error_* for information about the error with the return code
xxxxxxxxxxvirtual int Run(QisMFlowUtil* util, const int argc, const char* const* argv) = 0;Get the error information corresponding to a condition represented by
ecode
xxxxxxxxxxvirtual const char* Get_error_msg(const int ecode) const = 0;virtual const char* Get_error_tag(const int ecode) const = 0;virtual const char* Get_error_context(const int ecode) const = 0;Returns the flow usage as a multi-line string
xxxxxxxxxxvirtual const char* Get_usage() const = 0;Returns the flow name and version as a single string
xxxxxxxxxxvirtual const char* Get_version() const = 0;xxxxxxxxxxclass QisMFlowRegister: public QisMExtensionAPI { ... };Represents the registry of QisMLib flows
Cast to a pointer of another version in the class hierarchy (base/derived)
Get the latest version number. Version numbers start at 1 and are reflected in the class name using the suffix V<number>. E.g <baseclass>V<version>
The topmost base class is version 1 (V1 implied)
The cast returns NULL if a version number is not recognized/implemented
xxxxxxxxxxvirtual void* QisMFlowRegister_cast(const int version) = 0;virtual const void* QisMFlowRegister_cast(const int version) const = 0;virtual int QisMFlowRegister_latest_version() const = 0;Add a flow identified by
nameand implemented byhandleto the registry of flows
xxxxxxxxxxvirtual void Register_flow(const char* name, QisMFlow* handle) = 0;Get the handle for the flow identified by
name
xxxxxxxxxxvirtual QisMFlow* Get_flow(const char* name) = 0;Get a list of available flows as a string of names seperated by
sep
xxxxxxxxxxvirtual const char* List_flows(const char* sep = "; ") const = 0;Last Updated -- Wed Sep 30 01:16:58 UTC 2026