Requirement navigation Functions

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

This page discusses:

Chapter.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).

Signature

Chapter.GetReqChildren() : List
Note: The GetReqChildren function can be applied to chapter, comment, requirement, requirement specification, specifications folder - or any derived type of one of those.

ReturnType

List

Example

req -> GetReqChildren() -> Size() > 0

Chapter.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).

Signature

Chapter.GetReqParents() : List
Note: This function can be applied to chapter, comment, requirement, requirement specification, specifications folder - or any derived type of one of those.

ReturnType

List

Example

chapter -> GetReqParents() -> Size() > 0

Comment.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).

Signature

Comment.GetReqParents() : List
Note: This function can be applied to chapter, comment, requirement, requirement specification, specifications folder - or any derived type of one of those.

ReturnType

List

Example

Comment -> GetReqChildren() -> Size() > 0

Requirement.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).

Signature

Requirement.GetReqChildren() : List
Note: The GetReqChildren function can be applied to chapter, comment, requirement, requirement specification, specifications folder - or any derived type of one of those.

ReturnType

List

Example

req -> GetReqChildren() -> Size() > 0

Requirement.GetReqDerivationSources()

This function retrieves all requirements pointing the input using a Derived Requirement relationship. It returns a list of requirements from which the input is derived.

Signature

Requirement.GetReqDerivationSources() : List

ReturnType

List

Example

req -> GetReqDerivationSources() -> Size() > 0
Note: This function expects a requirement (or any type derived from requirement).

Requirement.GetReqDerivationTargets()

This function retrieves all requirements pointed by the input using a "Derived Requirement" relationship.

Signature

Requirement.GetReqDerivationTargets() : List

ReturnType

List

Example

req -> GetReqDerivationTargets() -> Size() > 0
Note: This function expects a requirement (or any type derived from requirement).

Requirement.GetReqImplementors()

This function retrieves all objects directly implementing this requirement object (this function works on "root" connections and returns an empty list for other type of connection).

Signature

Requirement.GetReqImplementors() : List

ReturnType

List

Example

req -> GetReqImplementors() -> Size() > 0
Note: This function expects a list of objects pointing directly the input through an "Implement Link" .

Requirement.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).

Signature

Requirement.GetReqParents() : List
Note: This function can be applied to chapter, comment, requirement, requirement specification, specifications folder - or any derived type of one of those.

ReturnType

List

Example

req -> GetReqParents() -> Size() > 0

Requirement Specification.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).

Signature

Requirement Specification.GetReqChildren() : List
Note: The GetReqChildren function can be applied to chapter, comment, requirement, requirement specification, specifications folder - or any derived type of one of those.

ReturnType

List

Example

req spec -> GetReqChildren() -> Size() > 0

Requirement Specification.GetReqImplementors()

This function retrieves all objects directly implementing this requirement object (this function is works on "root" connections, will return an empty list for other type of connection).

Signature

Requirement Specification.GetReqImplementors() : List

ReturnType

List

Example

req -> GetReqImplementors() -> Size() > 0
Note: This function expects a list of objects pointing directly the input through an "Implement Link" .

Requirement.GetReqParameters()

This function retrieves the list of PLM parameters that are either aggregated to or referenced by a requirement. These parameters detail the objectives that must be reached to consider the requirement as satisfied.

Note: This function is deprecated. For more information, see PLMParameterFunctions Functions.

Signature

Requirement.GetReqParameters() : List

ReturnType

List

Requirement Specification.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).

Signature

Requirement Specification.GetReqParents() : List
Note: This function can be applied to chapter, comment, requirement, requirement specification, specifications folder - or any derived type of one of those.

ReturnType

List

Example

req spec-> GetReqParents() -> Size() > 0