Overview
The PackageCall object permits a block of E-Basic script to be loaded into the Experiment Specification file from a text file. The PackageCall object is most useful when a segment of script is used by multiple experiments. The use of PackageFiles reduces the copying, pasting, and maintenance of inserting script that is reused often. PackageCall objects refer to PackageFiles (*.epk3) containing E-Basic script that adheres to a required format. PackageFiles define one or more code routines that may be accessed through a PackageCall object once the appropriate PackageFile is installed in the program.
The PackageCall object as it appears in the Toolbox.
NOTE: View OVERVIEW: Extending Experiments with PackageFile Editor [22888] for more information on creating PackageFiles.
Adding PackageFiles
To use a PackageFile in an experiment, it must be added to the experiment via the Packages tab in the Experiment object Property pages. Double-click the Experiment object in the Structure view to display the Property pages, and select the Packages tab.
Each PackageFile must exist in a unique subdirectory within the Packages folder portion of the E- Prime installation (default location is C:\Program Files\PST\E-Prime 3.0\Program\Packages). When the Add... button is clicked, The Add Package dialog will be displayed, showing all available packages. Select the appropriate file in the Available Packages column and click OK. Once added, the PackageFile’s icon will be displayed on the Packages tab with the Experiment object’s Property Pages.
The checkbox next to the PackageFile’s icon allows a specific PackageFile to be enabled or disabled without uninstalling or reinstalling. When a PackageFile is disabled, no script will be inserted from the file during the compile process.
Using PackageFiles
After the appropriate PackageFile is added in the Experiment object, the code routines contained within the PackageFile may be accessed using a PackageCall object in E-Studio. The PackageCall object is equivalent to inserting a segment of user-written script into a Procedure via an InLine object. The placement of the PackageCall in the experiment’s Procedures determines where the script called by the PackageCall is inserted in the complete experiment script when generated.
Interface
Dragging the PackageCall object icon to the Workspace, or double-clicking a PackageCall object in the Structure view will open the object’s Property pages for editing.
Property Pages
The properties for the PackageCall object may be set using the Property pages. The Property pages may be displayed by double-clicking the PackageCall object in the Structure view, or by clicking the ellipses (…) in the Property Pages field in the Properties window.
General Tab
The General tab permits the identification of the PackageFile and routine to be called, as well as the parameters required by that routine.
| Property | Possible Values | Description |
| Package | Installed .epk3 files, selected from dropdown | Name of the PackageFile to be called. |
| Routine | Suboutines defined in the PackageFile, selected from dropdown | Name of the routine to be called. |
| Parameters | Package-dependent | Parameters passed to the routine. |
| Details | Read-Only | User defined string that is useful for associating information with an object. |
Properties Window
| Property | Possible Values | Description |
| (Name) | String values | Assigns a user-entered string as the name of the object. |
| (About) | -------- | Displays the About Label dialog (currently not implemented). |
| (Property Pages) | -------- | Displays the Property pages for the object. |
| GeneratePostRun | Inherit, EndOfProcedure, AfterObjectRun | Where the postrun part of this object is generated in the script. |
| GeneratePretRun | Inherit, TopOfProcedure, BeforeObjectRun | Where the prerun part of this object is generated in the script. |
| Notes | String values | User-entered text useful for storing information or comments related to an object. |
| Package | Installed .epk3 files, selected from dropdown | Name of the PackageFile to be called. |
| Parameters | Package-dependent | Parameters passed to the routine. |
| Routine | Suboutines defined in the PackageFile, selected from dropdown | Name of the routine to be called. |
| Tag | String values, Attribute references. | User-defined string that is useful for associating information with an object. |
Next Article: E-STUDIO: Scripting Object [22714]
Previous Article: E-STUDIO: Label Object [22712]
Comments
0 comments
Please sign in to leave a comment.