Compute Length of Route Component (LSR_GetLengthOfRouteComponent)

An opening ID is an entry point used to customize business logic. LSR_GetLengthOfRouteComponent computes length of route component.

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 each time the user tries to select another component than a branch during the Manual Route command.

This opening ID is used to customize:

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

PLM Opening ID: LSR_GetLengthOfRouteComponent
Customization intent: Computation
Execution context:

Input Objects

Input objects must be of the following types:

  • ThisObject: Corresponds to the selected Route Component.
  • Parameters: Corresponds to the context object.
  • Validation: Variable to set to know if the validation succeeded or failed.

Context Object Parameters

Parameter NameTypeRead/WriteComments
Severity Read

Set to 1 to raise a warning (routing will continue).

Set to 2 to identify an error (routing is interrupted).

MessageWriteEnter the string to be displayed in the warning or error message dialog box.
RouteLengthLengthReadCorresponds to the length of the route component.

Sample

The following sample returns a default Routed Length for the selected Route component.

/* CATRule SIGNATURE BEGIN (do not edit) ------------------------------------ */
Let RouteLength_attr      = "RouteLength"
Let RouteLength_val         (Length)               /* In Meters */

/* CATRule SIGNATURE END ---------------------------------------------------- */

/* LOCAL VARIABLES BEGIN ---------------------------------------------------- */
 Let Attr_Length          = "Length"
/* LOCAL VARIABLES END ------------------------------------------------------ */

/* USER ATTRIBUTE VALUES BEGIN ---------------------------------------------- */
/* New Route Component Length */
RouteLength_val           = 0.111m

/* USER ATTRIBUTE VALUES END ------------------------------------------------ */

/* SET VALUES BEGIN --------------------------------------------------------- */

Parameters -> SetAttributeDimension( RouteLength_attr,      RouteLength_val, Attr_Length )

/* SET VALUES END ----------------------------------------------------------- */