All Frameworks  Object Hierarchy  This Framework  Indexes

FunctActionsGroup (Object)

The interface to access a group of functional actions in a system.

Property Index

ActionsCount
Get the count of actions referenced by the actions' group.

Method Index

Add
Adds an action to the actions' group.
GetExtremities
Get coordinates of Input and Output extremities.
RemovePosition
Removes an action from the actions' group.
Remove
Removes an action from the actions' group.
Retrieve
Returns an action using its index or its name from the actions group.
SetExtremities
Set coordinates of Input and Output extremities.

Properties


o Property ActionsCount() As (Read Only)
Get the count of actions referenced by the actions' group.

Methods


o Sub Add( iAction)
Adds an action to the actions' group.

Fails if the action :

  • is already in a group
  • has "From" and "To" extremities inconsistent with the existing actions.

In case of an ordered group, the added action will be appended.
(i.e. for flows sequencing actions)

Parameters:
iAction
The action to be added to the group of actions.
o Sub GetExtremities( oInputX,
oInputY,
oOutputX,
oOutputY)
Get coordinates of Input and Output extremities.
o Sub RemovePosition( iPosition)
Removes an action from the actions' group.

Parameters:
iPosition
The position of the action to be removed from the group of actions.
o Sub Remove( iAction)
Removes an action from the actions' group.

Parameters:
iAction
The action to be removed from the group of actions.
o Func Retrieve( iIndex) As
Returns an action using its index or its name from the actions group.
Parameters:
iIndex
The index or the name of the action to retrieve from the group of actions. As a numerics, this index is the rank of the action in the group. The index of the first action in the group is 1, and the index of the last action is Count. As a string, it is the name you assigned to the action using the
AnyObject.Name property.
Returns:
The retrieved action
Example:
This example retrieves in Obj1 the fifth action in the group and in Obj2 the action named Valve. 
 Dim Act1 As FunctionalAction
 Set Act1 = ActionsGrp.Retrieve(5)
 Dim Act2 As FunctionalAction
 Set Act2 = ActionsGrp.Retrieve("Reduces noise")
o Sub SetExtremities( iInputX,
iInputY,
iOutputX,
iOutputY)
Set coordinates of Input and Output extremities.

Copyright © 2003, Dassault Systèmes. All rights reserved.