The EndReport sub is the entry point to start customizing a report. You can change its content, but you may not delete, or rename it, or add parameters to it.
Use the template of the All Feeder Load Summary (Enhanced) report as an example.
In order to retrieve an electrical tree, you must call the RunLoadCalculation function of the m_objXLAgent object. This function retrieves the electrical tree for the selected power distribution boards or selected buses. Note that the m_objXLAgent object is supplied with the software.
This function has the following parameters:
-
An object belonging to the IPlantItemsTree type, holds the electrical tree that was read and calculated.
-
A collection that contains additional information. The following list contains the keys and their items:
-
SelectedSPIDs — A collection that contains unique IDs of the selected items.
-
CompensatedUncompensated — A value of the CompensatedUncompensated enumeration (declared in the Constants module). This value indicates the selection of compensated or uncompensated values in the Report Preferences dialog. This value exists only if the third parameter of the RunLoadCalculation function is true.
-
RatedConsumed — A value of the RatedConsumed enumeration (declared in the Constants module). This value indicates the selection of rated or consumed value on the Report Preferences dialog. This value exists only if the third parameter of the RunLoadCalculation function is true.
-
ReportType — A report type string description.
-
CalcMode — A string containing information about the coincidence factors that have been used, per load or per bus.
-
Coupling — A string containing information about the inclusion preference option of the tied buses.
-
Losses — A string containing information if the converting equipment losses have been accounted for in the calculation.
-
IncludeConverting — A Boolean value indicating if the converting equipment losses have been accounted for in the calculation.
-
A Boolean value, to instruct the software whether or not to open the Report Preferences dialog box before the calculation process starts.
Returned value — Long, zero (0) on success, error code on failure.
If the function succeeds, the first parameter will contain a IPlantItemsTree object. You now may explore this object and print the calculation results or any other property value of any item in the tree.