2 XOasis Functions

This section provides syntax, descriptions, and examples for the SKILL functions associated with the XOasis translator.

There are three types of SKILL functions in XOasis:

User-defined SKILL Functions

There are two types of user-defined SKILL functions in XOasis:

User-defined Command Line SKILL Functions

poCellNameMap

For information related to this function, see poCellNameMap.

poLayerMap

For information related to this function, see poLayerMap.

poTextMap

For information related to this function, see poTextMap.

poParamCellNameMap

For information related to this function, see poParamCellNameMap.

poPreTranslate

For information related to this function, see poPreTranslate.

poPostTranslate

For information related to this function, see poPostTranslate.

piCellNameMap

For information related to this function, see piCellNameMap.

piLayerMap

For information related to this function, see piLayerMap.

piTextMap

For information related to this function, see piTextMap.

piPreTranslate

For information related to this function, see piPreTranslate.

piPostTranslate

For information related to this function, see piPostTranslate.

User-defined GUI SKILL Functions

xoasInOnCancel

xoasInOnCancel()

Description

This is a user-defined function, which is called when you press the Cancel button.

Value Returned

None

Example

procedure( xoasInOnCancel()
             sprintf(“Translation canceled“)
);procedure

xoasInOnTranslate

xoasInOnTranslate()

Description

This is a user-defined function, which is called when you press the Apply or Translate button.

Value Returned

None

Example

procedure( xoasInOnTranslate()
             sprintf(“Starting Translation“)
);procedure

xoasInOnCompletion

xoasInOnCompletion(t_num
)
=> t_num

Description

This is a user-defined function, which is called when the translation is completed.

Arguments

t_num

It is an integer parameter.

Value Returned

t_num

Returns an integer value. If the translation is completed with error then it returns a non-zero value. However, if the translation is completed without any error then it returns zero.

Example

In this example, if the function returns 0, the translation is completed successfully. However, if the function returns any non-zero value, then errors occurred during translation.

procedure( xoasInOnCompletion( status )
            prog( ( )
            fprintf(outPort "In xoasInOnCompletion of XOasis In GUI: %d\n" status)
            if( status == 0 then
            fprintf(outPort "Successfully completed\n" status)
            else
            fprintf(outPort "Error occured during translation\n" status)
            );if
            );prog
)

xoasOutOnCancel

xoasOutOnCancel()

Description

This is a user-defined function, which is called when you press the Cancel button.

Arguments

None

Value Returned

None

Example

procedure( xoasOutOnCancel()
             sprintf(“Translation canceled“)
);procedure

xoasOutOnTranslate

xoasOutOnTranslate()

Description

This is a user-defined function, which is called when you press the Apply or Translate button.

Arguments

None

Value Returned

None

Example

procedure( xoasOutOnTranslate()
             sprintf(“Starting Translation“)
);procedure

xoasOutOnCompletion

xoasOutOnCompletion(t_num
)
=> t_num

Description

This is a user-defined function, which is called when the translation is completed.

Arguments

t_num

It is an integer parameter.

Value Returned

t_num

Returns an integer value. If the translation is completed with error then it returns a non-zero value. However, if the translation is completed without any error then it returns 0.

Example

In this example, if the function returns 0, the translation is completed successfully. However, if the function returns any non-zero value, then the error has occurred during translation.

procedure( xoasOutOnCompletion( status )
            prog( ( )
            fprintf(outPort "In xoasOutOnCompletion of XOasis Out GUI: %d\n" 
            status)
            if( status == 0 then
            fprintf(outPort "Successfully completed\n" status)
            else
            fprintf(outPort "Error occured during translation\n" status)
            );if
            );prog
)

GUI SKILL Functions

xoasInGetField

xoasInGetField(
t_optionName)
=> t_value / nil

Description

Enables you to access GUI field values from the XOasis In form. You can access all the GUI field values using the appropriate option name.

Arguments

t_optionName

The name of the field that needs to be accessed from the XOasis In form.

Valid values are the command line option name of the XOasis In form field, virtualMemory and showCompletionMsgBox. For list of valid values, see XOasis In Option Names in GUI and Template File.

Value Returned

t_value	The value returned from the XOasis In form
`nil`	If the field name specified in the `t_optionName` argument is incorrect

Example

Using SKILL commands, you can access the values specified in various fields, such as text box, check box, radio button, drop-down menu, and mapping tables, of the XOasis In form. A few examples are given below:

Text box: If you want to access the value in the OASIS File field in the XOasis In form, then you need to enter the following syntax in CIW:
```
xoasInGetField("oasisFile")
```
```
=> "test.gds"
```
Check box: On the Geometry tab, if you want to access the value selected in the Ignore Box Records option, then you need to enter the following syntax in CIW:
```
xoasInGetField("ignoreBoxes")
```
```
=> "true"
```
This field returns a Boolean value.
Radio Button: On the General tab, if you want to access the value selected in the Label Case Sensitivity option, then you need to enter the following syntax in CIW:
```
xoasInGetField("labelCase")
```
```
=> "upper"
```
Mapping Table: On the Layer tab, if you want to access the table with the layer map entries, then you need to enter the following syntax in CIW:
```
xoasInGetField("layerMap")
```
```
=> "l.map"
```

Here, the l.map file contains the layer mapping entries.

xoasInSetField

xoasInSetField(
t_optionName
t_value
)
=> t / nil

Description

Enables you to populate GUI field values in the XOasis In form. You can populate all the GUI field values using the appropriate option name and value.

Arguments

t_optionName

The name of the field that needs to be populated in XOasis In form.

Valid values are the command line option name of the XOasis In form field, virtualMemory and showCompletionMsgBox. For list of valid values, see XOasis In Option Names in GUI and Template File.

t_value

The value by which the field needs to be populated.

Value Returned

`t`	The value is populated in the XOasis In form
`nil`	If the value is not populated in the XOasis In form

Example

Using SKILL commands, you can populate the values in various fields, such as text box, check box, radio button, drop-down menu, and mapping tables, of the XOasis In form. A few examples are given below:

Text box: If you want to populate the OASIS File field in the XOasis In form, then you need to enter the following syntax in CIW:
```
xoasInSetField("oasisFile" "test.gds")
```
Check box: On the Geometry tab, if you want to select the Ignore Box Records option, then you need to enter the following syntax in CIW:
```
xoasInSetField("ignoreBoxes" "true")
```
This field accepts the Boolean value.
Radio Button: On the General tab, if you want to select the Label Case Sensitivity option as upper, then you need to enter the following syntax in CIW:
```
xoasInSetField("labelCase" "upper")
```
Mapping Table: On the Layer tab, if you want to populate the table with the layer map entries, then you need to enter the following syntax in CIW:
```
xoasInSetField("layerMap" "l.map")
```
Here, the l.map file contains the layer mapping entries.

xoasInDoTranslate

xoasInDoTranslate()

Description

Issues the XOasis In command based on the GUI field values. By default, this function is a non-blocking function. However, if the Import OASIS into Virtual Memory option is selected, then this function becomes a blocking function.

Before executing the xoasInDoTranslate function, you need to specify the value for the OASIS File and specify the value for either Library fields or the OASIS File field in the XOasis In form.

Argument

None

Value Returned

nil

Example

In this example, you translate OASIS File, in.gds, to library, lib1. To do this, you need to execute the following functions:

xoasInSetField("oasisFile" "in.gds")

xoasInSetField("library" "lib1")

xoasInDoTranslate()

xoasOutGetField

xoasOutGetField(
t_optionName)
=> t_value / nil

Description

Enables you to access GUI field values from the XOasis Out form. You can access all the GUI field values using the appropriate option name.

Arguments

t_optionName

The name of the field that needs to be accessed from the XOasis Out form.

Valid values are the command line option name of the XOasis Out form field, virtualMemory and showCompletionMsgBox. For list of valid values, see XOasis Out Option Names in GUI and Template File.

Value Returned

t_value	The value returned from the XOasis Out form
`nil`	If the field name specified in the t_optionName argument is incorrect

Example

If you want to access the value in the OASIS File field in the XOasis Out form, then you need to enter the following syntax in CIW:

xoasOutGetField("strmFile")

=> "test.gds"

If you want to access the value selected in the Export OASIS from Virtual Memory check box, then you need to enter the following syntax in CIW:

xoasOutGetField("virtualMemory")

=> "true"

This field returns a Boolean value.

xoasOutSetField

xoasOutSetField(
t_optionName
t_value)
=> t / nil

Description

Enables you to populate GUI field values in the XOasis Out form. You can populate all the GUI field values using the appropriate option name and value.

Arguments

t_optionName

The name of the field that needs to be populated in the XOasis Out form.

t_value

The value by which the field needs to be populated.

Value Returned

`t`	The value is populated in the XOasis Out form.
`nil`	If the value is not populated in the XOasis Out form.

Example

If you want to populate the OASIS File field in the XOasis Out form, then you need to enter the following syntax in CIW:

xoasOutSetField("oasisFile" "test.gds")

However, there are some special cases where you want to translate a copy of the design present in the virtual memory. To do this, you need to select the Export OASIS from Virtual Memory check box by using the following syntax in CIW:

xoasOutSetField("virtualMemory" "true")

xoasOutDoTranslate

xoasOutDoTranslate()

Description

Issues the XOasis Out command based on the GUI field values. By default, this function is a non-blocking function. However, if the Export OASIS from Virtual Memory option is selected, then this function becomes a blocking function.

Before executing the xoasOutDoTranslate function, you need to either specify the values for both the OASIS File and Library fields or the Cell List File field in the XOasis Out form.

Argument

None

Value Returned

nil

Example

In this example, you translate library, lib1, to OASIS file, out.gds. To do this, you need to execute the following functions:

xoasOutSetField("oasisFile" "out.gds")

xoasOutSetField("library" "lib1")

xoasOutDoTranslate()

Callback Functions

xoasInOnCancelCB

xoasInOnCancelCB(
t_mode
S_callbackFunction
)
t / nil

Description

Registers or unregisters a user-defined callback function when you click the Cancel button on the XOasis In form.

Arguments

t_mode

Specifies mode to register or unregister the user-defined callback function.

Valid values:

"r" Registers the user-defined callback function.
"d"Unregisters an already registered user-defined callback function.

S_callbackFunction

Name or function symbol of a user-defined callback function.

Value Returned

`t`	Function is successfully registered or unregistered.
`nil`	Function is not registered or unregistered.

Examples

Register the user-defined callback function myxoasInOnCancel when the Cancel button is clicked on the XOasis In form.

procedure( myxoasInOnCancel()

                print("Cancel button clicked")

xoasInOnCancelCB("r" 'myxoasInOnCancel)

xoasInOnCancelCB("r" "myxoasInOnCancel")

Unregister the user-defined callback function myxoasInOnCancel when the Cancel button is clicked on the XOasis In form.

procedure( myxstInOnCancel()

                print("Cancel button clicked")

xoasInOnCancelCB ("d" 'myxoasInOnCancel)

xoasInOnCancelCB("d" "myxoasInOnCancel")

xoasInOnCompletionCB

xoasInOnCompletionCB(
t_mode
S_callbackFunction
)
=> t / nil

Description

Registers or unregisters a user-defined callback function when the XOasis In translation is complete.

Arguments

t_mode

Specifies mode to register or unregister the user-defined callback function.

Valid values:

"r" Registers the user-defined callback function.
"d"Unregisters an already registered user-defined callback function.

S_callbackFunction

Name or function symbol of a user-defined callback function.

Value Returned

`t`	Function is successfully registered or unregistered.
`nil`	Function is not registered or unregistered.

Examples

procedure( myxoasInOnCompletion()

                print("Translation completed with status %L")

xoasInOnCompletionCB("r" 'myxoasInOnCompletion)

xoasInOnCompletionCB("r" "myxoasInOnCompletion")

Unregister the user-defined callback function myxoasInOnCompletion when the XOasis In translation is complete.

procedure( myxoasInOnCompletion()

                print("Cancel button clicked")

xoasInOnCompletionCB ("d" 'myxoasInOnCompletion)

xoasInOnCompletionCB("d" "myxoasInOnCompletion")

xoasInOnTranslateCB

xoasInOnTranslateCB(
t_mode
S_callbackFunction
)
=> t / nil

Description

Registers or unregisters a user-defined callback function when you click the Apply or Translate button on the XOasis In form.

Arguments

t_mode

Specifies mode to register or unregister the user-defined callback function.

Valid values:

"r" Registers the user-defined callback function.
"d"Unregisters an already registered user-defined callback function.

S_callbackFunction

Name or function symbol of a user-defined callback function.

Value Returned

`t`	Function is successfully registered or unregistered.
`nil`	Function is not registered or unregistered.

Examples

procedure( myxoasInOnTranslate()

                print("Translate button clicked")

xoasInOnTranslateCB("r" 'myxoasInOnTranslate)

xoasInOnTranslateCB("r" "myxoasInOnTranslate")

Unregister the user-defined callback function myxoasInOnTranslate when the XOasis In translation is complete.

procedure( myxstInOnTranslate()

                print("Cancel button clicked")

xoasInOnTranslateCB("d" 'myxoasInOnTranslate)

xoasInOnTranslateCB("d" "myxoasInOnTranslate")

xoasOutOnCancelCB

xoasOutOnCancelCB(
t_mode
S_callbackFunction
)
=> t / nil

Description

Registers or unregisters a user-defined callback function when you click the Cancel button on the XOasis Out form.

Arguments

t_mode

Specifies mode to register or unregister the user-defined callback function.

Valid values:

"r" Registers the user-defined callback function.
"d"Unregisters an already registered user-defined callback function.

S_callbackFunction

Name or function symbol of a user-defined callback function.

Value Returned

`t`	Function is successfully registered or unregistered.
`nil`	Function is not registered or unregistered.

Examples

Register the user-defined callback function myxoasOutOnCancel when you click the Cancel button on the XOasis Out form.

procedure( myxoasOutOnCancel()

                print("Cancel button clicked")

xoasOutOnCancelCB("r" 'myxoasOutOnCancel)

xoasOutOnCancelCB("r" "myxoasOutOnCancel")

Unregister the user-defined callback function myxoasOutOnCancel when you click the Cancel button on the XOasis Out form.

procedure( myxoasOutOnCancel()

                print("Cancel button clicked")

xoasOutOnCancelCB("d" 'myxoasOutOnCancel)

xoasOutOnCancelCB("d" "myxoasOutOnCancel")

xoasOutOnCompletionCB

xoasOutOnCompletionCB(
t_mode
S_callbackFunction
)
=> t / nil

Description

Registers or unregisters a user-defined callback function when the XOasis Out translation is complete.

Arguments

t_mode

Specifies mode to register or unregister the user-defined callback function.

Valid values:

"r" Registers the user-defined callback function.
"d"Unregisters an already registered user-defined callback function.

S_callbackFunction

Name or function symbol of a user-defined callback function.

Value Returned

t	Function is successfully registered or unregistered.
nil	Function is not registered or unregistered.

Examples

procedure( myxoasOutOnCompletion()

                print("Translation completed with status %L")

xoasOutOnCompletionCB("r" 'myxoasOutOnCompletion)

xoasOutOnCompletionCB("r" "myxoasOutOnCompletion")

Unregister the user-defined callback function myxoasOutOnCompletion when the XOasis Out translation is complete.

procedure( myxoasOutOnCompletion()

                print("Cancel button clicked")

xoasOutOnCompletionCB ("d" 'myxoasOutOnCompletion)

xoasOutOnCompletionCB("d" "myxoasOutOnCompletion")

xoasOutOnTranslateCB

xoasOutOnTranslateCB(
t_mode
S_callbackFunction
)
=> t / nil

Description

Registers or unregisters a user-defined callback function when you click the Apply or Translate button on the XOasis Out form

Arguments

t_mode

Specifies mode to register or unregister the user-defined callback function.

Valid values:

"r" Registers the user-defined callback function.
"d"Unregisters an already registered user-defined callback function.

S_callbackFunction

Name or function symbol of a user-defined callback function.

Value Returned

t	Function is successfully registered or unregistered.
nil	Function is not registered or unregistered.

Examples

procedure( myxoasOutOnTranslate()

                print("Translate button clicked")

xoasOutOnTranslateCB("r" 'myxoasOutOnTranslate)

xoasOutOnTranslateCB("r" "myxoasOutOnTranslate")

Unregister the user-defined callback function myxoasOutOnTranslate when the XOasis Out translation is complete.

procedure( myxoasOutOnTranslate()

                print("Cancel button clicked")

xoasOutOnTranslateCB ("d" 'myxoasOutOnTranslate)

xoasOutOnTranslateCB("d" "myxoasOutOnTranslate")

Return to top

Design Data Translators SKILL ReferenceProduct Version IC23.1, November 2023

2

XOasis Functions

User-defined SKILL Functions

User-defined Command Line SKILL Functions

poCellNameMap

poLayerMap

poTextMap

poParamCellNameMap

poPreTranslate

poPostTranslate

piCellNameMap

piLayerMap

piTextMap

piPreTranslate

piPostTranslate

User-defined GUI SKILL Functions

xoasInOnCancel

Description

Value Returned

Example

xoasInOnTranslate

Description

Value Returned

Example

xoasInOnCompletion

Description

Arguments

Value Returned

Example

xoasOutOnCancel

Description

Arguments

Value Returned

Example

xoasOutOnTranslate

Description

Arguments

Value Returned

Example

xoasOutOnCompletion

Description

Arguments

Value Returned

Example

GUI SKILL Functions

xoasInGetField

Description

Arguments

Value Returned

Example

xoasInSetField

Description

Arguments

Value Returned

Example

xoasInDoTranslate

Description

Argument

Value Returned

Example

xoasOutGetField

Description

Arguments

Value Returned

Example

xoasOutSetField

Description

Arguments

Value Returned

Example

xoasOutDoTranslate

Description

Argument

Value Returned

Example

Callback Functions

xoasInOnCancelCB

Description

Arguments

Design Data Translators SKILL Reference
Product Version IC23.1, November 2023