Get Equipment By-Pass (ELE_GetEquipmentByPass)

An opening ID is an entry point used to customize business logic. The Get Equipment By-Pass opening ID is available in the Electrical Logical Resources resource set and is used to define how the signal gets out of the equipment.

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 Electrical Calculation command.

This opening ID is used to customize:

  • The input pin through wich the signal is getting in the equipment.
  • The outpin from which the signal is getting out.

DefinitionDescription
PLM Opening IDELE_GetEquipmentByPass
Customization intent Execution
Execution contextClient

Input Objects

Input objects must be of the following types:

  • ThisObject: equipment occurrence (LogicalEquipmentOcc)
  • Parameters corresponds to the context object.

Context Object Parameters

Parameter NameTypeRead or WriteComments
iEqtPortEleLogicalConnectorPortRead The port of the equipment
iEqtPinEleLogicalPinRead The pin of the equipment
ostrPortNameString Write The name of the output port
ostrPinNameStringWrite The name of the output pin in the output port

Sample

/* Rule : ELE_GetEquipmentByPass */	
// input args 
let eqtPin(EleLogicalPin) 
let eqtPort(EleLogicalConnectorPort)
// output args
let strPinOut(String)
let strPortOut(String)

let segreg(String)
let pos(Integer)
let seglength(Integer)

strPinOut = ""
strPortOut = ""

set eqtPort = Parameters.GetAttributeObject("iEqtPort")
set eqtPin = Parameters.GetAttributeObject("iEqtPin")

// Read value in "Segregation" field -  we search for a value formated : "CntPort.PinNum"
if (NULL <>  eqtPin And NULL <> eqtPort)
{
	//ok to get input pin and port  
	segreg = eqtPin->GetAttributeString("V_Elec_SepCode")  
	pos = segreg->Search(".",0,TRUE)
	seglength = segreg->Length()
	if (pos <> -1)  {
		strPortOut = segreg->Extract(0, pos)
		strPinOut = segreg->Extract(pos + 1 , seglength - 1 - pos)
	}
}
Parameters.SetAttributeString("ostrPortName", strPortOut)
Parameters.SetAttributeString("ostrPinName", strPinOut)