Systems 3D Allocation User Functions

This page gives you information about the following Systems 3D Allocation User Functions.

This page discusses:

AddBasicBox

Syntax:

AddBasicBox (LogicalReference [RFLVPMLogicalReference], ShapeName[String], Dimension1 [Real], Dimension2 [Real], Dimension3 [Real], ResultMessage[String])

Adds a basic box shape to the input logical reference. Dimension1, Dimension2 and Dimension3 are for the dimensions of the Box (Width, Length, Height), Result Message for potential messages returned to the user.

Important: If the 3DRep already exists on passed in logical item, the method fails and a message is displayed.

AddBasicCylinder

Syntax:

AddBasicCylinder (LogicalReference [RFLVPMLogicalReference], ShapeName[String], Dimension1 [Real], Dimension2 [Real], ResultMessage[String]))

Adds a basic cylinder shape to the input logical reference. Dimension1 and Dimension2 are for the dimensions of the cylinder (Radius, Length) , ResultMessage for potential messages returned to the user.

Important: In case the 3DRep already exists on passed in logical item, the method fails and a message is displayed.

AssociatedEquipmentCenter

Syntax:

AssociatedEquipmentCenter(RFLVPMLogicalInstance):RFLVPMLogicalInstance which has a RFLVPMLogicalReference [V_discipline=EquipmentCenter]

Retrieves the equipment center instance to which the logical instance is allocated.

AssociatedPCPFromPort

Syntax:

AssociatedPCPFromPort (RFLVPMLogicalInstance, RFLVPMLogicalPort):(RFLVPMLogicalInstance, RFLVPMLogicalPublication [V_discipline=PathwayCnctPt])

Retrieves the pathway connection point of the identified logical instance associated with the logical port of the identified logical instance.

AssociatedPortsToPCP

Syntax:

AssociatedPortsToPCP (RFLVPMLogicalInstance, RFLVPMLogicalPublication [V_discipline=PathwayCnctPt] ):List (RFLVPMLogicalInstance, RFLVPMLogicalPort)

Returns the list of logical ports of the identified logical instance associated to the pathway connection point of the identified logical instance.

DistanceFromPathway

Syntax:

GetDistanceFromPathway (Object1 [feature: Pathway Segment or Pathway], Object2 [feature or RFLVPMLogicalInstance], Distance [Real])

Gives the minimum distance between Object1 and Object2. Object1 can be a feature (Pathway or Pathway Segment), Object2 can be a feature (Pathway or Pathway Segment) and RFLVPMLogicalInstance Distance is the minimum distance between these two objects. Function returns True if it succeeds, Fail otherwise.

EquipmentCenterAllocation

Syntax:

EquipmentCenterAllocation(RFLVPMLogicalInstance which has a RFLVPMLogicalReference [V_discipline=EquipmentCenter]):List(RFLVPMLogicalInstance)

Returns the list of logical instances allocated to the equipment center instance.

Example:

Let ItemList(List)
Let ListSize(Integer)
Let strMessage(String)

ItemList = EquipmentCenterAllocation(EquipmentCenter)
strMessage = "Equipment Center has" + ItemList->Size() + "allocated items"

if (ItemList->Size()<>0)Message(strMessage)

GetLogicalRoutingAttributes

Syntax:

GetRoutingAttributes (LogicalConnection[RFLVPMLogicalConnection], Segregation[String],UserLength[Real], RoutedLength[Real], ResultMessage[String])

Gets the logical routing attribute values of the passed in logical Connection.

Note: The code is dedicated to Logical Wires and Pipes. Check if the object is a routable one as the first filter inside the function.

GetPhysicalRoutingAttributes

Syntax:

GetRoutingAttributes (LogicalConnection[RFLVPMLogicalConnection], Segregation[String],UserLength[Real], RoutedLength[Real], ResultMessage[String])

Gets the physical routing attribute values of the passed in logical Connection.

Note: The code is dedicated to Logical Wires and Pipes. Check if the object is a routable one as the first filter inside the function.

RoutableObjectsRoutedTogether

Syntax:

RoutableObjectRoutedTogether (LogicalInstance [RFLVPMLogicalInstance] , Routables[List])

Gets on the passed in Logical Instance: both the other routables sharing the same routing parameters and the list of routables routed in the same segments.

Note: The code is dedicated to Logical Wires and Pipes. Check if the object is a routable one as the first filter inside the function.

LogicalRouteOfRoutableObject

Syntax:

RouteOfRoutableObject (LogicalInstance [RFLVPMLogicalInstance] , SegmentList[List])

Gets the pointed Pathway Segments on the passed in Logical instance, if there are some (else exit with S_FALSE according to the message and in case the segment List is empty).

If there are some segments, return to the list of the segments.

Note: The code is dedicated to Logical Wires and Pipes. Check if the object is a routable one as the first filter inside the function.

PhysicalRouteOfRoutableObject

Syntax:

RouteOfRoutableObject (LogicalInstance [RFLVPMLogicalInstance] , SegmentList[List])

Gets the pointed Branch Segments on the passed in Logical instance, if there are some (else exit with S_FALSE according to the message and in case the segment List is empty).

If there are some segments, return to the list of the segments.

Note: The code is dedicated to Logical Wires and Pipes. Check if the object is a routable one as the first filter inside the function.

SetRoutingAttributes

Syntax:

SetRoutingAttributes (LogicalInstance [RFLVPMLogicalInstance] , Segregation[String], UserLength[Real] ,ResultMessage[String])

Sets the routing attributes (Segregation and UserLength) on the passed in Logical Instance.

Note: The code is dedicated to Logical Wires and Pipes. Check if the object is a routable one as the first filter inside the function.