All Frameworks  Object Hierarchy  This Framework  Indexes

Activity (Object)

The object that represents an activity.

It groups the most important methods related to an activity and enables to get the management interfaces (hierarchy management, control flow management, * ...).

Property Index

AttrCount
This property returns the number of attributes of the current activity.
BeginningDate
This property returns the beginning date of the current activity.
CalculatedBeginTime
This property returns and calculated time cyle on the current activity.
CalculatedCycleTime
This property returns and sets the calculated time cyle on the current activity.
ChildrenActivities
This property returns the interface which manages the children hierarchy on the activity.
CycleTime
This property returns and set the time cyle on the current activity.
Description
This property returns and set the description on the current activity.
EndDate
This property returns the end date of the current activity.
Items
This property returns the interface which manages the items or input products/components assigned to the current activity
NextCFActivities
This property returns the interface which manages the downstream control flow hierarchy on the activity.
NextPRFActivities
This property returns the interface which manages the downstream product flow hierarchy on the activity.
Outputs
This property returns the interface which manages the output products/components of the current activity
Parameters
This property returns the interface which manages the knowlegde parameters of the activity.
PossiblePrecedenceActivities
This property returns list of Possible Precedence Activities defined on Current Activity.
PrecedenceActivities
This property returns list of Precedence Activities defined on Current Activity.
PreviousCFActivities
This property returns the interface which manages the upstream control flow hierarchy on the activity.
PreviousPRFActivities
This property returns the interface which manages the upstream product flow hierarchy on the activity.
ProcessID
This property returns process identifier on the current activity.
Relations
This property returns the interface which manages the knowlegde relations of the activity.
Resources
This property returns the interface which manages the resources hierarchy on the activity.
Type
This method returns the type of the current activity.

Method Index

AttrName
This method returns the name for the specified attribute.
AttrValue
This method returns the value for the specified attribute.
CreateChild
This method creates a new child activity of the requested type.
CreateLink
This method creates a link from the current activity to another activity.
GetTechnologicalObject
Returns the process's applicative data which type is the given parameter.
IsSubTypeOf
This method allows to test the type of a specific activity.
RemoveLink
This method removes a link existing on the current activity.
SetProcessID
Sets the process ID of the current activity

Properties


o Property AttrCount() As (Read Only)
This property returns the number of attributes of the current activity.
Returns:
oNbAttr The number of attributes
o Property BeginningDate() As
This property returns the beginning date of the current activity.
Returns:
oBegin The beginning date of the current activity
o Property CalculatedBeginTime() As (Read Only)
This property returns and calculated time cyle on the current activity.
Returns:
oCBT The calculated begin time of the current activity
o Property CalculatedCycleTime() As (Read Only)
This property returns and sets the calculated time cyle on the current activity.
Returns:
oCCT The calculated time cycle of the current activity
o Property ChildrenActivities() As (Read Only)
This property returns the interface which manages the children hierarchy on the activity.
o Property CycleTime() As
This property returns and set the time cyle on the current activity.
Returns:
oCT The time cycle of the current activity
Parameters:
iCT
The specified time cycle of the current activity
o Property Description() As
This property returns and set the description on the current activity.
Returns:
oDescriptionBSTR The description of the current activity
Parameters:
iDescriptionBSTR
The specified description of the current activity
o Property EndDate() As (Read Only)
This property returns the end date of the current activity.
Returns:
oEnd The end date of the current activity. Till V5R13, this method is returning S_OK even if there is no good implementation. Starting from V5R14 this method will return E_NOIMPL. Hence all the scripts that use this method would have to be updated to accomodate this change.
o Property Items() As (Read Only)
This property returns the interface which manages the items or input products/components assigned to the current activity
o Property NextCFActivities() As (Read Only)
This property returns the interface which manages the downstream control flow hierarchy on the activity.
o Property NextPRFActivities() As (Read Only)
This property returns the interface which manages the downstream product flow hierarchy on the activity.
o Property Outputs() As (Read Only)
This property returns the interface which manages the output products/components of the current activity
o Property Parameters() As (Read Only)
This property returns the interface which manages the knowlegde parameters of the activity.
o Property PossiblePrecedenceActivities() As (Read Only)
This property returns list of Possible Precedence Activities defined on Current Activity.
Parameters:
oActivities
List of Activities that must precede the Current Activity
o Property PrecedenceActivities() As (Read Only)
This property returns list of Precedence Activities defined on Current Activity.
Parameters:
oActivities
List of Activities that must precede the Current Activity
o Property PreviousCFActivities() As (Read Only)
This property returns the interface which manages the upstream control flow hierarchy on the activity.
o Property PreviousPRFActivities() As (Read Only)
This property returns the interface which manages the upstream product flow hierarchy on the activity.
o Property ProcessID() As (Read Only)
This property returns process identifier on the current activity.
Parameters:
oProcessID
The process ID of the current activity
o Property Relations() As (Read Only)
This property returns the interface which manages the knowlegde relations of the activity.
o Property Resources() As (Read Only)
This property returns the interface which manages the resources hierarchy on the activity.
o Property Type() As (Read Only)
This method returns the type of the current activity.
Parameters:
oType
The type of the current activity

Methods


o Func AttrName( iIndex) As
This method returns the name for the specified attribute.
Parameters:
iIndex
The attribute index
oName
The attribute name
o Func AttrValue( iIndex) As
This method returns the value for the specified attribute.
Parameters:
iIndex
The attribute identifier
Returns:
oAttVal The attribute value
o Func CreateChild( iTypeOfChild) As
This method creates a new child activity of the requested type.
Parameters:
iTypeOfChild
The type of the child activity to create.
oCreatedChild
The new created child activity.
o Sub CreateLink( iSecondActivity)
This method creates a link from the current activity to another activity.
Parameters:
iSecondActivity
The activity that will be linked to the current activity.
o Func GetTechnologicalObject( iApplicationType) As
Returns the process's applicative data which type is the given parameter. The data returned can be either a collection or a simple object.
Parameters:
iApplicationType
The type of applicative data searched.
Example:
This example retrieves the GraphEditor position for the Loading1 activity. 
 Dim GEPosition 
 Set GEPosition = Loading1.GetTechnologicalObject("GEPosition")
o Func IsSubTypeOf( iName) As
This method allows to test the type of a specific activity.
Parameters:
iName
The name of the type to test
Returns:
oVal The logical value returned by the test
o Sub RemoveLink( iSecondActivity)
This method removes a link existing on the current activity.
Parameters:
iSecondActivity
The activity on which the link will be removed.
o Sub SetProcessID( iProcessID,
iCheckUnique)
Sets the process ID of the current activity
Parameters:
iProcessID
Input Process ID string
iCheckUnique
Option to enable uniqueness check

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