Logical3DSystems Functions Functions

This page gives you information about the following Logical 3D Architecture User Functions.

This page discusses:

AssociatedEquipmentCenter

This function retrieves the equipment center instance to which the logical instance is allocated.

Signature

AssociatedEquipmentCenter(LogicalInst : RFLVPMLogicalInstance) : RFLVPMLogicalInstance

Arguments

Name Input/Output Required? Type Comment
LogicalInst In Yes RFLVPMLogicalInstance -

ReturnType

RFLVPMLogicalInstance

AssociatedPCPFromPort

This function retrieves the pathway connection point of the identifed logical instance associated with the logical port of the identified logical instance.

Signature

AssociatedPCPFromPort(LogicalInst : RFLVPMLogicalInstance, Port : RFLVPMLogicalPort, LogicalInstOp : RFLVPMLogicalInstance, PCP : RFLVPMLogicalPublication) : Boolean

Arguments

Name Input/Output Required? Type Comment
LogicalInst In Yes RFLVPMLogicalInstance -
Port In Yes RFLVPMLogicalPort -
LogicalInstOp Out Yes RFLVPMLogicalInstance -
PCP Out Yes RFLVPMLogicalPublication -

ReturnType

Boolean

AssociatedPortsToPCP

This function returns the list of logical ports of the identifed logical instance associated to the pathway connection point of the identified logical instance.

Signature

AssociatedPortsToPCP(PCP : RFLVPMLogicalPublication, LogicalInst : RFLVPMLogicalInstance, ListOfLogicalInstances : List, ListOfPorts : List) : Boolean

Arguments

Name Input/Output Required? Type Comment
PCP In Yes RFLVPMLogicalPublication -
LogicalInst In Yes RFLVPMLogicalInstance -
ListOfLogicalInstances Out Yes List -
ListOfPorts Out Yes List -

ReturnType

Boolean

EquipmentCenterAllocation

This function returns the list of logical instances allocated to the equipment center instance.

Signature

EquipmentCenterAllocation(EquipmentCenter : RFLVPMLogicalInstance) : List

Arguments

Name Input/Output Required? Type Comment
EquipmentCenter In Yes RFLVPMLogicalInstance -

ReturnType

List

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)

GetDistanceFromPathway

This function gives the minimum distance between Object1 and Object2.

Signature

GetDistanceFromPathway(Pathway/PathwaySegment Feature : Feature, LFS Object : Feature, MinimumDistance : Real) : Boolean

Arguments

Name Input/Output Required? Type Comment
Pathway/PathwaySegment Feature In Yes Feature -
LFS Object In Yes Feature Pathway, PathwaySegment or RFLVPMLogicalInstance
MinimumDistance Out Yes Real -

ReturnType

Boolean

RFLVPMLogicalReference.AddBasicBox()

This function adds a basic box shape to the input logical reference.

Signature

RFLVPMLogicalReference.AddBasicBox(ShapeName : String, DimensionOne : Real, DimensionTwo : Real, DimensionThree : Real, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
ShapeName In Yes String Defines the name of the shape.
DimensionOne In Yes Real Defines the width.
DimensionTwo In Yes Real Defines the length.
DimensionThree In Yes Real Defines the height.
ReturnMessage Out Yes String Returns a message error to the user.

ReturnType

Boolean

RFLVPMLogicalReference.AddBasicCylinder()

This function adds a basic cylinder shape to the given logical reference.

Signature

RFLVPMLogicalReference.AddBasicCylinder(ShapeName : String, DimensionOne : Real, DimensionTwo : Real, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
ShapeName In Yes String Defines the name of the shape.
DimensionOne In Yes Real Defines the radius.
DimensionTwo In Yes Real Defines the length.
ReturnMessage Out Yes String Returns a message error to the user.

ReturnType

Boolean