Compute Filling Ratio of the Segment (EHINetwork_ComputeSegmentFillingRatio)

An opening ID is an entry point used to customize business logic. The Computes filling ratio of the segment opening ID is available in the Electrical physical system design resources set and it is used to customize the computation of the segment's filling ratio for network analysis.

Note: For more information about customization by business rules, see Installation and Setup: Customize: Behavior: Data Setup: Customization by Business Rules.

This page discusses:

General Information

This opening ID is invoked during the Network Analysis command. See Electrical 3D Design User's Guide: Analyzing your Design: Using the Network Assistant.

Thanks to the Network Assistant, you can analyze your electrical network to identify connectivity problems and check segment filling ratio. This opening ID is used to compute the segment filling ratio according to your own values set in the business rules and the result is displayed accordingly in the work area.

The table below provides you with information related to the definition of the Opening ID.

PLM Opening ID: EHINetwork_ComputeSegmentFillingRatio
Customization intent: Computation
Execution context:Client

Input Objects

Input objects must be of the following types:

  • ThisObject: The segment for which the business rule is to be used.
  • Parameters:
    • SegmentFillingRatio: Output (Real): The filling ratio of segment computed by business rule.
    • Severity and Message are available as standard business rule parameters. But these parameters are not used for customizing the network assistant result / computation.
  • Computation: Variable to set to compute the segment filling ratio according to your own criteria.
  • Severity information:
    • Severity= 0 the treatment is to be continued (no message)
    • Severity= 1 the treatment is to be continued and only a warning raised.
    • Severity= 2 the treatment is supposed to be undone.

Context Object Parameters

Parameter NameTypeRead/WriteComments
SegmentFillingRatio: Output (Real)Real ReadSegment filling ratio to compute.

Sample

The following sample explains how to use an opening ID to customize the filling ratio computation of a whole segment.

/* CATRule signature (do not edit) : (ThisObject : #In Segment, Parameters : #In RuleContext) : #Void */
/* Rule created by ABC MM/DD/YYYY */

Let result (BOOLEAN)
Let FillingRatio (REAL)
Let sMessage (STRING)
Let severity (INTEGER)

set FillingRatio = 0.0

result = ThisObject->Elec_FillingRatio(FillingRatio)

/* Though the severity and message has no impact on behavior, we set it */
if(FillingRatio >= 0.8)
{
    severity = 1
    set sMessage = "Some sections are filled more than 80%"
}
else if( (FillingRatio < 0.8) and (FillingRatio >= 0.5) )
{
    set severity = 1
    set sMessage = "All sections are filled less than 80% but more than 50%"
}
else
{
    set severity = 0
    set sMessage = "All sections are filled less than 50%"
}
Parameters.SetAttributeReal("SegmentFillingRatio", FillingRatio)
Parameters.Severity = severity
Parameters.Message = sMessage