[Artwork] / [QisMLib]

QisMcadWriter

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

QisMcadWriter composes new layout files on disk in either GDSII or OASIS, the two standard formats for storing chip layouts. Rather than editing an existing file, it lets a program or a script build one from scratch: open a file with a chosen unit and grid, define cells, place rectangles, polygons, paths, text and references to other cells, and close the file with all of the required bookkeeping records in place.

Two features set it apart. Any shape can be given a repetition, so one definition stands for a whole row, grid or scattered set of copies. And geometry can be written into independent data blocks, each backed by its own temporary file, that are merged into the main file only when committed. That makes it practical for several threads or processes to compose parts of a large file at the same time.

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

If you want to generate a file from a script, start with the script commands. If you are writing software that emits layout files, read the glossary first and then move on to the C++ programming interface.


Glossary of Terms

User Unit

Grid

DBU

QisMcadWriter C++ API (qismcadwriterapi.h)

struct QisMcadOpts

Optional parameters for various operations

class QisMcadOffsets

API to define repetitions (as x,y offsets) for geometries, texts and references

Version Control

Cast this pointer to any other version (base/derived)

Reset()

Clear the list of repeating offsets

Add_single()

Add a single offset at x and y (in dbu) to the existing list

Add_lattice()

Add offsets that repeat uniformly along X and Y to the existing list

Add_arbitrary()

Add arbitrary list of offsets (in dbu) to the existing list

class QisMcadProperty

Represents properties to be associated with appropriate records

Version Control

Cast this pointer to any other version (base/derived)

Reset()

Clear the property fields

Add_fields()

Add data to the current property

class QisMcadBlock

API to work with a data block. A data block is a contiguous chunk of CAD records that represents geometries, texts and cell references

Version Control

Cast this pointer to any other version (base/derived)

Get_block_error_msg()

Get_block_error_tag()

Get_block_error_context()

Get information about an error condition corresponding the the return value (code)

Units_m()

Grid_m()

Grid_uu()

Get the units, grid of the CAD block in meter

File_path()

Get the path of the block on disk

Repetition()

Use this to define repetitions (offsets) for various records

Real_to_int()

Convert a list of values in user units to database units

Boundary()

Add a boundary to the data block

Path()

Add a path to the data block

Text()

Add a text to the data block

Reference()

Add a cell reference to the data block

class QisMcadWriter

Represents a GDSII/OASIS writer object

Version Control

Cast this pointer to any other version (base/derived)

Get_error_msg()

Get_error_tag()

Get_error_context()

Get information about an error condition corresponding the the return value (code)

Begin_cad()

Write the opening records for the CAD file

Begin_cell()

Start a new cell definition

File_block()

Get a handle to the file (main) block of the CAD stream

Create_block()

Create a new data block

Commit_and_destroy()

Merge the specified block to the main (file) block and then destroy that block

Destroy_without_commit()

Destroy the CAD block without merging with the main (file) stream

End_cell()

End_cad()

Write the closing records for the CAD file

class QisMcadWriterAPI

Primary interface to the QisMcadWriter API

Version Control

Cast this pointer to any other version (base/derived)

Get_error_msg()

Get_error_tag()

Get_error_context()

Get information about an error condition corresponding the the return value (code)

Open_CAD()

Close_writer()

Create a GDSII or OASIS writer

QisMCADWriter Commands

cadwriter.open

cadwriter.begin_cell

cadwriter.create_block

cadwriter.box

cadwriter.text

cadwriter.box_set

cadwriter.bstore

cadwriter.boundary

cadwriter.path

cadwriter.circle

cadwriter.reference

cadwriter.commit_block

cadwriter.end_cell

cadwriter.close

QisMcadWriter API Licensing

Product name: QisMcadWriter Product code: 16001 (GDSII), 16007 (OASIS)

OperationPolicy
QisMcadWriterAPI::Open_CAD - GDSIIAcquire one license of 16001 per call
QisMcadWriterAPI::Open_CAD - OASISAcquire one license of 16007 per call
QisMcadWriterAPI::Close_writerRelease 16001 or 16007 depending on the format

QisMcadWriter Script Licensing

Product name: QisMcadWriter Product code: 16001 (GDSII), 16007 (OASIS)

OperationPolicy
cadwriter.open - format=GDSIIAcquire one license of 16001 per call
cadwriter.open - format=OASISAcquire one license of 16007 per call
cadwriter.closeRelease 16001 or 16007 depending on the format

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 17:41:21 UTC 2026