Integrator Object Methods

Schematic 3D Integrator User Guide

How to use Integrator from the Command Line : Integrator Object Methods

The method signatures for Build, Compare, Link and Unlink are shown below. These correspond to the interactive operations described in the Main Table Context Menu in Integrator Controls. The string arguments can be a name like /MyName or a reference like =123/45678. The array arguments are arrays of strings of the same format.

!!integrator.build(!Name is STRING)

!!integrator.build(!Names is ARRAY)

!!integrator.compare(!Name is STRING)

!!integrator.compare(!Names is ARRAY)

!!integrator.link(!Name1 is STRING, !Name2 is STRING)

!!integrator.unlink(!Name is STRING)

!!integrator.unlink(!Names is ARRAY)

By default the Compare Report is generated to the screen. In order to send the report direct to file the following two lines are needed to suppress the output to screen and set the pathname:

!!integrator.setreportvisible(false)

!!integrator.setreportpath('c:\reports\rep.xml')

If the pathname of the report file has been specified as shown above, then the report can be viewed in the Compare form using the following command (note that this command cannot be used in non-graphics mode).

!!integrator.openreport()

Access to the current setting for the option "Report unpositioned elements" is provided by the following two methods:

!!integrator.getReportCheckPosition()

!!integrator.setReportCheckPosition(!Flag is BOOLEAN)

Access to the current setting for the option "Compare Pipelines and Pipes without their member hierarchies" is provided by the following two methods:

!!integrator.getCompareNoHierarchy()

!!integrator.setCompareNoHierarchy(!Flag is BOOLEAN)

The following methods have been provided to set flags to auto-link matched objects and auto-update attributes:

!!integrator.setCompareAutoLinkMatches(!Flag is BOOLEAN)

!!integrator.setCompareAutoUpdateAttributes(!Flag is BOOLEAN)

If these are set true then the next use of the compare method will perform these functions.

The following method has been provided to select a Comparison Category:

!!integrator.setComparisonCategory(!ComparisonCategory is STRING)

To reset to the default Comparison Category (all categories on), use the following form:

!!integrator.setComparisonCategory('Default')

Integrator link information stored on CYMLNK objects includes references to the linked objects. It is possible during project execution for these references to become invalid when objects are deleted. A method is provided to clean up CYMLNK objects with invalid references.

!!Integrator.ValidateLinks()

Caution: This method should be used only when all of the databases holding objects that have been linked are current on the MDB.

The following method has been provided to set the option for limiting compare analysis.

!!integrator.compareStrictlyLimited(!Flag is BOOLEAN)

The following method can be used to clear the Integrator 3D graphical view drawlist:

!!integratorSupportHandler.intdrawlist().removeall()