SysML_To_HiLeS/SysMLModelQueries [ Modules ]

[ Top ] [ SysML_To_HiLeS ] [ Modules ]

SUMMARY

Support operations to query the SysML model. ($Rev: 128 $)

DESCRIPTION

Set of eol operations to query information form the SysML model. Primary, these queries are to solve realtions not present in the SysML metamodel.


SysMLModelQueries/getActivityPins [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Get the Activity Pins of an Activity

FUNCTION

Returns a set that contains all the activity pins of an activity

DOMAIN

sysmlModel!Activity - The SysML model activity from whcih the pins are required

SYNOPSIS

operation sysmlModel!Activity getActivityPins() : sysmlModel!Pin

RESULT

Set(sysmlModel!Pin) - The set of activity pins

EXAMPLE


SysMLModelQueries/getChildrenBlocks [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Get the children blocks of a block.

FUNCTION

From the associations that have the block as an origin, the children blocks are found.

DOMAIN

sysmlModel!Block - The SysML model block fro whcih the children are required

SYNOPSIS

operation sysmlModel!Block getChildrenBlocks() : Set

RESULT

Set(sysmlModel!Block) - The block's children

EXAMPLE

   var lsp :sysmlModel!Package = sysmlModel!Model.all().first().getLogicalSolutionPackage();
   var rootBlock = lsp.getMainBlock();

SysMLModelQueries/getFlowPorts [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Get the FlowPorts of a block

FUNCTION

Returns a set that contains all the flow ports of a block.

DOMAIN

sysmlModel!Block - The SysML model block from whcih the ports are required

SYNOPSIS

operation sysmlModel!Block getFlowPorts() : Sequence

RESULT

Set(sysmlModel!FlowPort) - The set of flow ports

EXAMPLE

   var lsp :sysmlModel!Package = sysmlModel!Model.all().first().getLogicalSolutionPackage();
   var rootBlock = lsp.getMainBlock();
   var flowPorts = rootBlock.getFlowPorts();

SysMLModelQueries/getLogicalSolutionPackage [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Query the SysML model for the Logical Solution package.

FUNCTION

Since a SysML model can contain various packages, this method allows to retreive the Logical Solution package whcih contains the structure and behavior descriptions of the system. The Logical Solution package is named "LogicalSolution".

DOMAIN

sysmlModel!Model - The SysML model to be queried

SYNOPSIS

operation sysmlModel!Model getLogicalSolutionPackage() : sysmlModel!Package

RESULT

sysmlModel!Package - The Logical Solution Package

EXAMPLE

   var lsp :sysmlModel!Package = sysmlModel!Model.all().first().getLogicalSolutionPackage();

SysMLModelQueries/getMainBlock [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Get the main block of a package (only valid for the logical solution package).

FUNCTION

The main block (or root block) is the block at the top of the hierachy, i.e. it has no parent.

DOMAIN

sysmlModel!Package - The SysML model package to query for the main block.

SYNOPSIS

operation sysmlModel!Package getMainBlock() : sysmlModel!Block

RESULT

sysmlModel!Block - The main block

EXAMPLE

   var lsp :sysmlModel!Package = sysmlModel!Model.all().first().getLogicalSolutionPackage();
   var rootBlock = lsp.getMainBlock();

SysMLModelQueries/getParentActivity [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Get the Parent Activity of an Activity Edge

FUNCTION

Returns the Activity in which the Edge is defined (i.e. its parent))

DOMAIN

sysmlModel!ActivityEdge - The SysML Activity Edge from whcih the parent is requried

SYNOPSIS

operation sysmlModel!ActivityEdge getParentActivity() : sysmlModel!Activity

RESULT

sysmlModel!Activity - The parent Activity

EXAMPLE


SysMLModelQueries/getParentActivity [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Get the Parent Activity of an Activity Node

FUNCTION

Returns the Activity in which the Node is defined (i.e. its parent))

DOMAIN

sysmlModel!ActivityNode - The SysML Activity Node from whcih the parent is requried

SYNOPSIS

operation sysmlModel!ActivityNode getParentActivity() : sysmlModel!Activity

RESULT

sysmlModel!Activity - The parent Activity

EXAMPLE


SysMLModelQueries/getParentBlock [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Get the Parent Block of an Activity

FUNCTION

Returns the block in which the Activity is defined (i.e. its parent))

DOMAIN

sysmlModel!Activity - The SysML model activity from whcih the parent is requried

SYNOPSIS

operation sysmlModel!Activity getParentBlock() : sysmlModel!Block

RESULT

sysmlModel!Block - The parent Block

EXAMPLE


SysMLModelQueries/hasChildrenBlocks [ Operations ]

[ Top ] [ SysMLModelQueries ] [ Operations ]

SUMMARY

Test if a block has children.

FUNCTION

From the associations that have the block as an origin, return true if at least one children is found.

DOMAIN

sysmlModel!Block - The SysML model block from whcih the children are required

SYNOPSIS

operation sysmlModel!Block hasChildrenBlocks() : Boolean

RESULT

Boolean - True if the block has at least one child, false otherwise

EXAMPLE

   var lsp :sysmlModel!Package = sysmlModel!Model.all().first().getLogicalSolutionPackage();
   var rootBlock = lsp.getMainBlock();