RFLPLMKnowledgeFunctions Functions

The RFLPLMKnowledgeFunctions provides functions to check and managed implement links and associated objects in an RFLP system.

This page discusses:

RFLPLMFlowExpositionInstance.AssociateContract()

This method enables you to associate a functional contract to a flow exposition instance.

You can specify two directions:

  • Emission: The emitted flow respects the associated contract.
  • Consumption: The function is able to consume any flow respecting the associated contract. The consuming flow describes the minimum features that it is able to consume.
Note: This method may fail depending on the result of the called validation business rules (PLMRelationEstablishmentCheck).

Signature

RFLPLMFlowExpositionInstance.AssociateContract(Functional Contract : RFLPLMFunctionalContract)

Arguments

Name Input/Output Required? Type Comment
Functional Contract In Yes RFLPLMFunctionalContract The functional contract to associate.

Example

let flowExpoInst(RFLPLMFlowExpositionInstance)
let fctContract(RFLPLMFunctionalContract)
…
set flowExpoInst=…
fctContract = new("RFLPLMFunctionalContract","AFunctionalContract") ;
flowExpoInst.associateContract(fctContract)

RFLPLMFlowExpositionInstance.DissociateContract()

This method enables you to dissociate a functional contract that is already associated to a flow exposition instance.

Signature

RFLPLMFlowExpositionInstance.DissociateContract(Functional Contract : RFLPLMFunctionalContract)

Arguments

Name Input/Output Required? Type Comment
Functional Contract In Yes RFLPLMFunctionalContract The functional contract to dissociate from a flow exposition Instance.

Example

let flowExpoInst(RFLPLMFlowExpositionInstance)
let fctContract(RFLPLMFunctionalContract)
…
set flowExpoInst=…
set fctContract =…
flowExpoInst.dissociateContract(fctContract)

RFLPLMFlowExpositionInstance.GetAssociatedContracts()

The method retrieves the functional contracts associated to a flow exposition instance.

Note: The retrieved associated functional contracts depend on the session content. Functional contracts are not systematically loaded when opening a functional structure.

Signature

RFLPLMFlowExpositionInstance.GetAssociatedContracts() : List

ReturnType

List

This method returns a list of the functional contracts associated to the flow exposition instance.

Example

let flowExpoInst(RFLPLMFlowExpositionInstance)
let associatedFctContracts(List)
…
set flowExpoInst=…
set associatedFctContracts = flowExpoInst.GetAssociatedContracts()
if(associatedFctContracts->Size() <> 0)
{
…
}

RFLPLMFunctionalConnection.GetImplementingLogicalSystems()

This function is described below.

Signature

RFLPLMFunctionalConnection.GetImplementingLogicalSystems(Functional Occurrence (Context) : FunctionalOccurrence) : List

Arguments

Name Input / Output Required? Type Comment
Functional Occurrence (Context) In Yes FunctionalOccurrence -

ReturnType

List

RFLPLMFunctionalConnector.ExposedTypeName()

This function returns the name (string) of the associated flow.

Signature

RFLPLMFunctionalConnector.ExposedTypeName() : String

ReturnType

String

Example

Let Port (RFLPLMFunctionalConnector)
Let PortTypeName (String)
...
Set PortTypeName = Port->ExposedTypeName()

RFLPLMFunctionalConnector.GetAssociatedFlow()

This function returns the flow reference (RFLPLMFlowReference) associated to this functional port.

Signature

RFLPLMFunctionalConnector.GetAssociatedFlow() : RFLPLMFlowReference

ReturnType

RFLPLMFlowReference

Example

Let FTypeReference (RFLPLMFlowReference)
Let FPort (RFLPLMFunctionalConnector)
...
Set FTypeReference=FPort->GetAssociatedFlow()

RFLPLMFunctionalConnector.GetAssociatedFlowInstance()

This function is described below.

Signature

RFLPLMFunctionalConnector.GetAssociatedFlowInstance() : RFLPLMFlowInstance

ReturnType

RFLPLMFlowInstance

RFLPLMFunctionalConnector.GetImplementingLogicalSystemsPorts()

This function is described below.

Signature

RFLPLMFunctionalConnector.GetImplementingLogicalSystemsPorts(Functional Occurrence (Context) : FunctionalOccurrence, List of Logical Occurrences : List, List of Logical Ports : List)

Arguments

Name Input / Output Required? Type Comment
Functional Occurrence (Context) In Yes FunctionalOccurrence -
List of Logical Occurrences Out Yes List -
List of Logical Ports Out Yes List -

RFLPLMFunctionalConnector.RemoveAssociatedFlow()

This function is described below.

Signature

RFLPLMFunctionalConnector.RemoveAssociatedFlow()

RFLPLMFunctionalConnector.SetAssociatedFlow()

This function is described below.

Signature

RFLPLMFunctionalConnector.SetAssociatedFlow(FlowReference : RFLPLMFlowReference)

Arguments

Name Input / Output Required? Type Comment
FlowReference In Yes RFLPLMFlowReference -

RFLPLMFunctionalInstance.NotConnectedPorts()

This function returns a list of functional ports (RFLPLMFunctionalConnector) which are not connected inside this instance.

Signature

RFLPLMFunctionalInstance.NotConnectedPorts() : List

ReturnType

List

Example

Let L (List)
Let FInstance(RFLPLMFunctionalInstance)
...
Set L=FInstance->NotConnectedPorts()

RFLPLMFunctionalReference.GetImplementingInContext()

This function is described below.

Signature

RFLPLMFunctionalReference.GetImplementingInContext(Context : RFLPLMFunctionalReference) : List

Arguments

Name Input / Output Required? Type Comment
Context In Yes RFLPLMFunctionalReference -

ReturnType

List

RFLPLMFunctionalReference.NotConnectedPorts()

This function returns a list of functional ports (RFLPLMFunctionalConnector) which are not connected inside this reference.

Signature

RFLPLMFunctionalReference.NotConnectedPorts() : List

ReturnType

List

Example

Let L (List)
Let FReference(RFLPLMFunctionalReference)
...
Set L=FReference->NotConnectedPorts()

RFLVPMLogicalInstance.NotConnectedPorts()

This function returns a list of logical ports (RFLVPMLogicalPort) which are not connected through this instance.

Signature

RFLVPMLogicalInstance.NotConnectedPorts() : List

ReturnType

List

Example

Let L (List)
Let LInstance(RFLPLogicalInstance)
...
Set L=LInstance->NotConnectedPorts()

RFLVPMLogicalPort.ExposedTypeName()

This function returns the name (string) of the associated system type.

Signature

RFLVPMLogicalPort.ExposedTypeName() : String

ReturnType

String

Example

Let Port (RFLPLMLogicalConnector)
Let PortTypeName (String)
...
Set PortTypeName = Port->ExposedTypeName()

RFLVPMLogicalPort.GetAssociatedSystemType()

This function is described below.

Signature

RFLVPMLogicalPort.GetAssociatedSystemType() : RFLVPMSystemTypeReference

ReturnType

RFLVPMSystemTypeReference

RFLVPMLogicalPort.GetAssociatedSystemTypeInstance()

This function is described below.

Signature

RFLVPMLogicalPort.GetAssociatedSystemTypeInstance() : RFLVPMSystemTypeInstance

ReturnType

RFLVPMSystemTypeInstance

RFLVPMLogicalPort.GetImplementedFunctionalSystemsPorts()

This function is described below.

Signature

RFLVPMLogicalPort.GetImplementedFunctionalSystemsPorts(Logical Occurrence (Context) : LogicalOccurrence, List of Functional Occurrences : List, List of Functional Connectors : List)

Arguments

Name Input / Output Required? Type Comment
Logical Occurrence (Context) In Yes LogicalOccurrence -
List of Functional Occurrences Out Yes List -
List of Functional Connectors Out Yes List -

RFLVPMLogicalPort.RemoveAssociatedSystemType()

This function is described below.

Signature

RFLVPMLogicalPort.RemoveAssociatedSystemType()

RFLVPMLogicalPort.SetAssociatedSystemType()

This function is described below.

Signature

RFLVPMLogicalPort.SetAssociatedSystemType(TypeReference : RFLVPMSystemTypeReference)

Arguments

Name Input / Output Required? Type Comment
TypeReference In Yes RFLVPMSystemTypeReference -

RFLVPMLogicalReference.GetImplementedInContext()

This function is described below.

Signature

RFLVPMLogicalReference.GetImplementedInContext(Context : RFLVPMLogicalReference) : List

Arguments

Name Input / Output Required? Type Comment
Context In Yes RFLVPMLogicalReference -

ReturnType

List

RFLVPMLogicalReference.NotConnectedPorts()

This function returns a list of logical ports (RFLVPMLogicalPort) which are not connected inside this reference.

Signature

RFLVPMLogicalReference.NotConnectedPorts() : List

ReturnType

List

Example

Let L (List)
Let LReferenceReference(RFLPLogicalReference)
...
Set L=LReference->NotConnectedPorts()