Bartels User Language - Programmer's Guide C.1 Function Reference

Each Bartels User Language system function is assigned to one of the caller types STD, CAP, LAY, SCM, GED, AR, CAM, CV, ICD or CED, respectively. This section lists the User Language system functions for each caller type.

Function Description Notations

Each detailed function description provided with this appendix indicates the function caller type and provides a formal function and/or parameter declaration. The function data type defines the data type of the corresponding function return value; void functions do not provide return values. The mode of operation of a function is explained in detail and/or illustrated by examples wherever necessary.

Parameter declarations can contain valid value range definitions. Such value range definitions consist of a lower and an upper value range boundary specification. Valid lower value range boundary specifications are:

Valid upper value range boundary specifications are:

The value range boundaries are separated by comma (,). The declaration

double ]0.0,[;

e.g., defines a parameter of type double, which must be greater than 0.0. The User Language Compiler knows about the parameter value ranges and issues error messages if parameter values are out of range.

A parameter declaration preceded with & indicates, that the corresponding parameter value is set and/or changed by the system function; the User Language Compiler will issue a warning message if a constant value or a calculation result is passed to such a parameter.

A parameter declaration preceded by * indicates that the corresponding parameter must reference a user function. The system function description contains the required user function declaration as well. When running the program, the system function will automatically activate the corresponding user function. The reference to the user function is usually optional; the keyword NULL must be used for the function reference parameter if no user function should be referenced. It is strongly recommended to take great care at the declaration of referenced user functions, since the User Language Compiler cannot recognize erroneous user function reference declarations (relating to required function data type, return value conventions, required parameters, etc.). In case of wrong function reference declarations the User Language Interpreter might show up with unpredictable results or fatal side effects at runtime.

A void system function parameter type indicates, that the corresponding parameter can be of any data type. A [] parameter type specification indicates, that the function expects optional parameters of any (void) type at this place.

C.1.1 Standard System Functions (STD)

The following User Language system functions are assigned to caller type STD; i.e., they can be called from each User Language Interpreter environment of the Bartels AutoEngineer (Schematic Editor, Layout Editor, Autorouter, CAM Processor, CAM View, IC Design and Chip Editor):

C.1.2 Schematic Capture System Functions (CAP)

The following User Language system functions are assigned to caller type CAP; i.e., they can be called from the Schematic Editor interpreter environment of the Bartels AutoEngineer:

C.1.3 Schematic Editor System Functions (SCM)

The following User Language system functions are assigned to caller type SCM; i.e., they can be called from the Schematic Editor interpreter environment of the Bartels AutoEngineer:

C.1.4 Layout System Functions (LAY)

The following User Language system functions are assigned to caller type LAY; i.e., they can be called from the Layout Editor, the Autorouter and the CAM Processor interpreter environment of the Bartels AutoEngineer:

C.1.5 Layout Editor System Functions (GED)

The following User Language system functions are assigned to caller type GED; i.e., they can be called from the Layout Editor interpreter environment of the Bartels AutoEngineer:

C.1.6 Autorouter System Functions (AR)

The following User Language system functions are assigned to caller type AR; i.e., they can be called from the Autorouter interpreter environment of the Bartels AutoEngineer:

C.1.7 CAM Processor System Functions (CAM)

The following User Language system functions are assigned to caller type CAM; i.e., they can be called from the CAM Processor interpreter environment of the Bartels AutoEngineer:

C.1.8 CAM View System Functions (CV)

The following User Language system functions are assigned to caller type CV; i.e., they can be called from the CAM View interpreter environment of the Bartels AutoEngineer:

C.1.9 IC Design System Functions (ICD)

The following User Language system functions are assigned to caller type ICD; i.e., they can be called from the Chip Editor interpreter environment of the Bartels AutoEngineer:

C.1.10 Chip Editor System Functions (CED)

The following User Language system functions are assigned to caller type CED; i.e., they can be called from the Chip Editor interpreter environment of the Bartels AutoEngineer:

Function Reference
© 1985-2024 Oliver Bartels F+E • Updated: 19 January 2013, 11:08 [UTC]