About RFLP Knowledge Functions, Methods and Types

This document describes the functions, methods, and types you can use when creating Engineering Rules Capture Checks and Rules. These Knowledge functions enable you to use knowledge script for functional and logical entities and for requirements.

This page discusses:

Knowledge Functions for RFL Entities

The available functions related to functional and logical componentsare listed below.

Functions Related to Functions and Logical Components

  • FLGet2DPosition: This function extracts the 2D position of a function/logical component instance or reference.
  • FLSet2DPosition: This function sets the 2D position of a function/logical component instance or reference.
  • FLGet2DSize: This function extracts the 2D size of a function/logical component instance or reference.
  • FLSet2DSize: This function sets the 2D size of a function/logical component instance or reference.
  • FLGet2DGraphicalProperties: This function extracts the graphical properties of a function/logical Instance/reference.
  • FLSet2DGraphicalProperties: This function sets the graphical properties of a function/logical Instance/reference.
  • FLExtract2DGraph: This function extracts the 2D graph of a function or logical component into a file of EMF format.
  • FLGetMinimizedStatus: This function extracts the minimized status of a function or logical component.
  • FLSetMinimizedStatus: This function minimizes (or maximizes) a function or logical component.

Functions Related to Functional and Logical Ports

The available functions related to functional and logical ports are listed below.

  • FLGet2DPosition: This function extracts the 2D position of a port as defined at the level of its owning reference or at the level of an instance of this reference.
  • FLSet2DPosition: This function extracts the 2D position of a port as defined at the level of its owning reference or at the level of an instance of this reference.
  • FLGet2DGraphicalProperties: This function extracts the graphical properties of a function/logical port as defined at the level of its owning reference or of an instance of this reference.
  • FLSet2DGraphicalProperties: This function sets the graphical properties of a function/logical port as defined at the level of its owning reference or of an instance of this reference.
  • FLGetMinimizedStatus: This function extracts the minimized status of the port of a function or logical component.
  • FLSetMinimizedStatus: This function minimizes (or maximizes) a port of a function/logical component.

Functions Related to Functional and Logical Connections

The available functions related to functional connections and logical connections are listed below.

  • FLGetWayPoints: This function extracts the position of the waypoints of a function or logical connection.
  • FLSetWayPoints: This function set the number of waypoints and their position for a function or logical connection.
  • FLGet2DGraphicalProperties: This function extracts the graphical properties of a function/logical connection.
  • FLSet2DGraphicalProperties: This function sets the graphical properties of a function/logical connection.

Functions Related to Requirements

The following functions are exposed in the Quality Rules Reuse tools for the requirement objects in Functional & Logical Design.

  • GetReqChildren: This function returns items pointed by the input through a structural relationship ("Specification Structure", "SubRequirement"). It returns a list of the objects directly attached under the input (e.g. if the input is a requirement specification, it will return all chapters, comments, or requirement directly attached under it).
  • GetReqParents: This function returns items pointed by the input through a structural relationship (Specification Structure, Sub Requirement). It returns a list of the parent objects (e.g. if the input is a requirement, this method will return all chapters/requirement specifications containing this requirement).
  • GetReqDerivationSources: This function retrieves all requirements pointing the input using a Downstream Requirement relationship. It returns a list of requirements from which the input is derived.
  • GetReqDerivationTargets: This function retrieves all requirements pointed by the input using a Downstream Requirement relationship.
  • GetReqImplementors: This function retrieves all objects directly implementing this requirement object (this function works on root connections and will return an empty list for other type of connection).

Knowledge Types for FL Entities

Specific knowledge types are available to handle the connectivity aspect of functional and logical models. These types are listed in RFLPLMKnowledge Types.

The following table gives examples of these types.

This type... is applied to...
SysPort RFLPLMFunctionalConnector
RFLVPMLogicalPort
SysConnection RFLPLMFunctionalConnection
RFLVPMLogicalConnection
SysConnectable RFLPLMFunctionalReference
RFLPLMFunctionalInstance
RFLPLMFunctionalCommunicationReference (MUX/DEMUX)
RFLPLMFunctionalCommunicationInstance
RFLVPMLogicalReference
RFLVPMLogicalInstance
RFLVPMLogicalCommunicationReference (MUX/DEMUX)
RFLVPMLogicalCommunicationInstance
...