3.1. Class Scripts

  • Overview: Scripts in class configuration.
  • Overview: Script included in a class.
  • Configuration: Class scripts.

Overview: Scripts in Class Configuration

Class scripts:

  • Can be created and modified in the CIMPLICITY Program Editor by opening it through the Class dialog box.
  • Can be available anywhere that standard CIMPLICITY project scripts are.
  • Are stored in the Workbench Scripts folder, with a class$ prefix, as soon as they are created.\
3.1.1 Open the CIMPLICITY Program Editor.
3.1.2 Class scripts definition.
3.1.3 Pre create script.
3.1.4 Post create script.

The class$ script can be modified in the CIMPLICITY Program Editor by opening it through the Workbench Scripts folder.

Overview: Script Included in a Class

A class retains one copy only of each script.

A Class: Script configuration.
B Instantiation: Class script availability.
  1. Class: Script Configuration

Class scripts are created and edited in the Program Editor. CIMPLICITY inserts <Class Name>$ in front of the script name as soon as it is created.

The syntax for each class script name is:

Class$Scriptname.bcl

Where

Class$ is the name of the class to which the script belongs.

Scriptname.bcl is the name entered in the New Script Name dialog box.

You can modify the script either through the Scripts folder or through the Class dialog box.

Example

A script, feedback.bcl, has been created for a TANKR class.

When feedback.bcl is opened in the Program Editor, the name on the title bar is TANKR$feedback.bcl.

  1. Instantiation: Class Script Availability

As soon as a class script is created or duplicated it is added to the Basic Control Engine>Scripts list and is available for objects.

Example

The TANKR$feedback.bcl is listed in the Workbench right pane. As soon as the Class is applied (clicking Apply or OK in the Class dialog box) the script will be applied to every object associated with TANKR.

Configuration: Class Scripts

3.1.1 Open the CIMPLICITY Program Editor.
3.1.2 Class scripts definition.
3.1.3 Post create script.