All Frameworks Class Hierarchy This Framework Next Indexes
DMAPSInterfaces Interface CATISPPAbstractActivity
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISPPAbstractActivity
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISPPAbstractActivity
Interface to use to manage any type of activity.
Role: this interface regroups all common methods for Physical and Logical Activities.
One other interface derives from this interface:
CATISPPActivity to manage Physical Activities.
Method Index
- o
GetActivityType(CATISPPActivityType**)
- Returns a pointer to the instance from which the activity has been instanciated.
- o
GetDescription()
- Returns the Description of an Activity.
- o
GetIcon()
- Returns the name of an icon associated to an Activity.
- o
GetLabel()
- Returns the Label (external user name) of an Activity.
- o
GetMother()
- Returns the parent activity of an Activity inside a hierarchy of activities.
- o
GetProcess()
- Returns the process which is a root activity, associated to an activity.
- o
GetType()
- Returns the type of the Activity as a character string containing the type name.
- o
GetTypeName(CATUnicodeString&)
- Returns the type of the Activity as a character string containing the type name.
- o
IsSubTypeOf(CATUnicodeString&)
- Tests the type of a specific Activity.
- o
SetDescription(CATUnicodeString&)
- Sets the Description of an Activity .
- o
SetIcon(CATUnicodeString&)
- Associates the name of an icon to an activity.
- o
SetLabel(CATUnicodeString&)
- Sets the Label (external user name) of an Activity .
Methods
o GetActivityType
-
Returns a pointer to the instance from which the activity has been instanciated.
- Parameters:
-
- oActivityType
- CATISPPActivityType pointer to the activity type object
- Returns:
- E_INVALIDARG if oActivityType==NULL
S_OK The ActivityType object is found and we successfully get an CATISPPACtivityType pointer on it
In former mode the object is the Startup
In new mode the activityType object is the object from which the activity is instanciated
E_FAIL The ActivityType object is not found or we don t get an CATISPPActivityType pointer on it
o GetDescription
-
Returns the Description of an Activity.
- Returns:
- returns "No Description" if no description was previously set .
o GetIcon
-
Returns the name of an icon associated to an Activity.
o GetLabel
-
Returns the Label (external user name) of an Activity.
Note: A default Label is given to an Activity as it is created.
o GetMother
-
Returns the parent activity of an Activity inside a hierarchy of activities.
- Returns:
-
- NULL_var
- if the Activity does not have a parent ( means that it is a Root Activity for that Process).
- CATISPPActivity_var
- as the handler on the parent activity if it exists.
o GetProcess
-
Returns the process which is a root activity, associated to an activity.
o GetType
-
Returns the type of the Activity as a character string containing the type name.
o GetTypeName
-
Returns the type of the Activity as a character string containing the type name.
- Parameters:
-
- oTypeName
-
- Returns:
- S_OK The ActivityType object is found and we return the type string.
E_UNEXPECTED The ActivityType object is not found so we return the SpecObject instance Name
E_FAIL The ActivityType object is not found and we don't get the SPecObject instance Name
o IsSubTypeOf
-
Tests the type of a specific Activity.
- Parameters:
-
- iTypeName
- given type or super type.
- Returns:
-
- TRUE
- when the Activity is of type or of sub-type of iTypeName.
- FALSE
- when the Activity is NOT of type or of sub-type of iTypeName.
o SetDescription
-
Sets the Description of an Activity .
- Parameters:
-
- iDescription
- description identifier.
o SetIcon
-
Associates the name of an icon to an activity.
- Parameters:
-
- iIcon
- icon name to associate.
No extension, nor path is needed, only the plain icon name.
o SetLabel
-
Sets the Label (external user name) of an Activity .
Note: The Label of an Activity does not need to be unique across a Process document.
A default Label is given to an Activity when it is created.
- Parameters:
-
- iLabel
- external name to set on the activity.
This object is included in the file: CATISPPAbstractActivity.h
If needed, your Imakefile.mk should include the module: CATProcessInterfaces