All Frameworks Class Hierarchy This Framework Indexes
DMAPSInterfaces Interface CATISPPChildManagement
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISPPChildManagement
Interface to manage Hierarchy, relationship Father - Son.
Method Index
- o
AddChild(CATBaseUnknown_var&,CATBaseUnknown_var&)
- Adds a child Activity to another one.
- o
AddChild(CATUnicodeString&)
- Adds a child Activity to another one.
- o
DetailInAnotherFile(CATUnicodeString)
- Sets path to file where the process is defined.
- o
GetAllChildren(CATUnicodeString&)
- Returns all children from the Activity, with the possibility to search for specific Activity types.
- o
GetChild(CATUnicodeString&)
- Returns the children from an Activity, with the possibility to search for specific Activity types.
- o
GetContainerWhereDetailed()
- Returns the container where the process is defined.
- o
GetExposedChildren(CATUnicodeString&)
- Returns the exposed (if applicable) children from an Activity, with the possibility to search for specific Activity types.
- o
GetNumberOfChild(CATUnicodeString&)
- Returns number of children from an Activity, with the possibility to search for specific Activity types.
- o
RemoveChild()
- Removes all the children of an Activity.
Methods
o AddChild
| public virtual AddChild( | const | iChild, |
| | oCreated) |
-
Adds a child Activity to another one.
- Parameters:
-
- iChild
- The child Activity to create
- oCreated
- A handle to the newly created object
- Returns:
- The result of the method
o AddChild
| public virtual AddChild( | const | entity_to_create) |
-
Adds a child Activity to another one.
- Parameters:
-
- iEntityToCreate
- Name of the Activity type from which the new Activity must be instantiated
- Returns:
- Handler on the newly created Activity.
o DetailInAnotherFile
| public virtual DetailInAnotherFile( | | iPath) |
-
Sets path to file where the process is defined.
- Parameters:
-
- iPath
- path to the file.
o GetAllChildren
| public virtual GetAllChildren( | const | type | = NULL_string) |
-
Returns all children from the Activity, with the possibility to search for specific Activity types.
- Parameters:
-
- iType
- Name of the Activity type used for the search, by default, equals to Activity (Physical)
- Returns:
- List of Interface Handlers for the Activities as Children
o GetChild
| public virtual GetChild( | const | type | = NULL_string) |
-
Returns the children from an Activity, with the possibility to search for specific Activity types.
Please note that it used to return all children, but from R20SP4 it returns exposed children, i.e.
it is the same as GetExposedChildren, a new method introduced. For clarity and ease of maintenance,
GetChild should NOT be used in any new code. Rather, either GetExposedChildren or GetAllChildren
should be used depending on need.
- Parameters:
-
- iType
- Name of the Activity type used for the search, by default, equals to Activity (Physical)
- Returns:
- List of Interface Handlers for the Activities as Children
o GetContainerWhereDetailed
| public virtual GetContainerWhereDetailed( | ) |
-
Returns the container where the process is defined.
o GetExposedChildren
| public virtual GetExposedChildren( | const | type | = NULL_string) |
-
Returns the exposed (if applicable) children from an Activity, with the possibility to search for specific Activity types.
- Parameters:
-
- iType
- Name of the Activity type used for the search, by default, equals to Activity (Physical)
- Returns:
- List of Interface Handlers for the Activities as Children
o GetNumberOfChild
| public virtual GetNumberOfChild( | const | type | =NULL_string) |
-
Returns number of children from an Activity, with the possibility to search for specific Activity types.
- Parameters:
-
- iType
- Name of the Activity type used for the search, by default, equals to Activity (Physical)
- Returns:
- Number of Activities
o RemoveChild
| public virtual RemoveChild( | ) |
-
Removes all the children of an Activity.
This object is included in the file: CATISPPChildManagement.h
If needed, your Imakefile.mk should include the module: CATProcessInterfaces