DELPPRProcessItf Interface DELIPPRProcessGroup
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DELIPPRProcessGroup
Interface to author process group.
Method Index
- o
AddProcessOrGroup(CATBaseUnknown*,DELIPPRProcessGroup::ErrorDiagnostic&)
- Adds a Process occurrence or a Group in the group.
- o
CreateAndInsertGroup(DELIPPRProcessGroup*&,DELIPPRProcessGroup::ErrorDiagnostic&)
- Creates an empty Group and inserts it under this.
- o
GetFather(CATBaseUnknown*&)
- Gets the father of the group.
- o
GetOwner(CATIPLMNavReference*&)
- Gets the process under which the group is aggregated.
- o
GetProcessesOrGroups(CATListPtrCATBaseUnknown&,CATIPLMNavReference*)
- Get the list of process occurrences or groups in the group.
- o
GetProcessesOrGroupsFirstLevel(CATListPtrCATBaseUnknown&,CATIPLMNavReference*)
- Gets the list of process occurrences or groups in the group on the first level (aggregated under the process owner of the Group).
- o
IsEmpty()
- Checks if the group does contain any process or group.
- o
IsObjectInsertionAuthorized(CATBaseUnknown*,DELIPPRProcessGroup::ErrorDiagnostic&)
- Checks if an object can be inserted in the group.
- o
IsObjectRemovalAuthorized(CATBaseUnknown*,DELIPPRProcessGroup::ErrorDiagnostic&)
- Checks if an object can be removed from the group.
- o
IsSubGroup()
- Checks if the group is a subgroup.
- o
RemoveProcessOrGroup(CATBaseUnknown*&,DELIPPRProcessGroup::ErrorDiagnostic&)
- Removes a Process occurrence or a Group from the group.
Methods
o AddProcessOrGroup
| public virtual AddProcessOrGroup( | | ipiProcessOrGroupToAdd, |
| | oDiagnostic) |
-
Adds a Process occurrence or a Group in the group.
The added object must be a child of the group owner.
- Parameters:
-
- ipiProcessOrGroupToAdd
- The object to add in the group: a process occurrence or a group
- oDiagnostic
- Precisions on the reason of the failure
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o CreateAndInsertGroup
| public virtual CreateAndInsertGroup( | | opiNewGroup, |
| | oDiagnostic) |
-
Creates an empty Group and inserts it under this.
- Parameters:
-
- oNewGroup
- The newly created and inserted group
- oDiagnostic
- [out] Precisions on the reason of the failure
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o GetFather
| public virtual GetFather( | | opiFather) |
-
Gets the father of the group.
- Parameters:
-
- opiFather
- The father of the group: the Process reference for a group; the upper group for a subgroup
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o GetOwner
| public virtual GetOwner( | | opiOwner) |
-
Gets the process under which the group is aggregated.
- Parameters:
-
- opiOwner
- The process under which the group is aggregated
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o GetProcessesOrGroups
| public virtual GetProcessesOrGroups( | | oListOfProcessesOrGroups, |
| | ipiContext) |
-
Get the list of process occurrences or groups in the group.
- Parameters:
-
- ipiContext
- The context as Process reference for occurrences computation
- oListOfProcessesOrGroups
- The list of objects in the group: a list of process occurrences or groups
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o GetProcessesOrGroupsFirstLevel
| public virtual GetProcessesOrGroupsFirstLevel( | | oListOfProcessesOrGroups, |
| | ipiContext) |
-
Gets the list of process occurrences or groups in the group on the first level (aggregated under the process owner of the Group).
- Parameters:
-
- ipiContext
- The context as Process Reference for occurrences computations
- oListOfProcessesOrGroups
- The list of objects in the first level group: a list of process occurrences or group
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o IsEmpty
-
Checks if the group does contain any process or group.
- Returns:
-
- TRUE : The group does not contain any object.
- FALSE : The group contains a process or a group.
o IsObjectInsertionAuthorized
| public virtual IsObjectInsertionAuthorized( | | ipiProcessOrGroupToAdd, |
| | oDiagnostic) |
-
Checks if an object can be inserted in the group.
- Parameters:
-
- ipiProcessOrGroupToAdd
- The object to add in the group: a process occurrence or a group
- oDiagnostic
- Precisions on the reason of the failure
- Returns:
- Legal values:
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o IsObjectRemovalAuthorized
| public virtual IsObjectRemovalAuthorized( | | ipiProcessOrGroupToRemove, |
| | oDiagnostic) |
-
Checks if an object can be removed from the group.
- Parameters:
-
- ipiProcessOrGroupToRemove
- The object to remove in the group: a process occurrence or a group
- oDiagnostic
- Precisions on the reason of the failure
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
o IsSubGroup
| public virtual IsSubGroup( | ) |
-
Checks if the group is a subgroup.
- Returns:
-
- TRUE : The group is a subgroup.
- FALSE : The group is not a subgroup.
-
o RemoveProcessOrGroup
| public virtual RemoveProcessOrGroup( | | ipiProcessOrGroupToRemove, |
| | oDiagnostic) |
-
Removes a Process occurrence or a Group from the group.
The added object must be a child of the group owner.
- Parameters:
-
- ipiProcessOrGroupToRemove
- The object to remove from the group: a process occurrence or a group
- oDiagnostic
- [out] Precisions on the reason of the failure
- Returns:
-
S_OK - if the method succeeds
E_INVALIDARG - if the input type is not valid
E_FAIL - if the method fails for any other reason
This object is included in the file: DELIPPRProcessGroup.h
If needed, your Imakefile.mk should include the module: DELPPRProcessItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.