DELPPRProcessItf Interface DELIPPRProcessNav
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface DELIPPRProcessNav
Interface for navigation in the Functional Process model.
Method Index
- o
GetAllGroups(CATIPLMNavReference*,CATListPtrDELIPPRProcessGroup&)
- Gets all the groups and sub-groups present under a given process reference.
- o
GetListOfAssignedProcesses(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&)
- Gets the process occurrences that are assigned to a given product occurrence within a given scope.
- o
GetListOfAssignedProducts(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&)
- Gets the product occurrences that are assigned to a given process occurrence.
- o
GetPredecessors(CATIPLMNavInstance*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&)
- Gets the predecessors (process occurrences) of a given process instance.
- o
GetPredecessors(CATIPLMNavReference*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&)
- Gets the predecessors (process occurrences) of a given process reference.
- o
GetPredecessors(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&)
- Gets the predecessors (process occurrences) of a given process occurrence.
- o
GetProcessOfEachScope(CATIPLMNavReference*,CATListPtrCATIPLMNavReference&)
- Gets the process reference of each scope of a given product reference.
- o
GetProductOfTheScope(CATIPLMNavReference*,void**,IID&)
- Gets the product reference of the scope of a given process reference.
- o
GetProductOfTheScope(CATIPLMNavReference*,int,CATIPLMNavReference*&)
- Load the target (Product/EBOM) that are linked through scope to the process
- o
GetSuccessors(CATIPLMNavInstance*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&)
- Gets the successors (process occurrences) of a given process instance.
- o
GetSuccessors(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&)
- Gets the successors (process occurrences) of a given process occurrence.
- o
GetWhereUsed(CATIAdpPLMIdentificator&,CATLISTP(CATIAdpPLMIdentificator)&)
- Retrieve all father Process References using a given Process Reference.
- o
NavigateFromPartOrPrdToProcessThroughScopeLink(CATIPLMNavReference*,CATOmbLifeCycleRootsBag&,CATListPtrCATBaseUnknown&)
-
Methods
o GetAllGroups
| public virtual GetAllGroups( | | ipiProcessRef, |
| | oListOfGroups) |
-
Gets all the groups and sub-groups present under a given process reference.
- Parameters:
-
- ipiProcessRef
- The process reference
- oListOfGroups
- the list of groups ans sub-groups
- Returns:
-
S_OK - method successfully ended
E_FAIL - method failed
o GetListOfAssignedProcesses
| public virtual GetListOfAssignedProcesses( | | ipiProductOcc, |
| | ipiProcessScope, |
| | ipiProcessContextForOutputOcc, |
| | oListProcessOcc) |
-
Gets the process occurrences that are assigned to a given product occurrence within a given scope.
- Parameters:
-
- ipiProductOcc
- The product occurrence
- ipiProcessScope
- The process reference representing the scope for which the assigned process occurrences are requested
- ipiProcessContextForOutputOcc
- The context (process reference) for the resulting occurrences
- oListProcessOcc
- The list of process occurrences
- Returns:
-
S_OK - if there is at least one implement link
S_FALSE - if there is no implement link
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetListOfAssignedProducts
| public virtual GetListOfAssignedProducts( | | ipiProcessOcc, |
| | ipiProductContextForOutputOcc, |
| | oListProductOcc) |
-
Gets the product occurrences that are assigned to a given process occurrence.
- Parameters:
-
- ipiProcessOcc
- The process occurrence
- ipiProductContextForOutputOcc
- The context (product reference) for the resulting occurrences
- oListProductOcc
- The list of product occurrences
- Returns:
-
S_OK - if there is at least one implement link
S_FALSE - if there is no implement link
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetPredecessors
| public virtual GetPredecessors( | | ipiProcessInst, |
| | ipiProcessContextForOutputOcc, |
| | oListProcessOcc) |
-
Gets the predecessors (process occurrences) of a given process instance.
- Parameters:
-
- ipiProcessInst
- The process instance
- ipiProcessContextForOutputOcc
- The context (process reference) for the resulting occurrences
- oListProcessOcc
- The list of predecessors (process occurrences)
- Returns:
-
S_OK - if there is at least one predecessor
S_FALSE - if there is no predecessor
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetPredecessors
| public virtual GetPredecessors( | | ipiProcessRef, |
| | ipiProcessContextForOutputOcc, |
| | oListProcessOcc) |
-
Gets the predecessors (process occurrences) of a given process reference.
- Parameters:
-
- ipiProcessRef
- The process reference
- ipiProcessContextForOutputOcc
- The context (process reference) for the resulting occurrences
- oListProcessOcc
- The list of predecessors (process occurrences)
- Returns:
-
S_OK - if there is at least one predecessor
S_FALSE - if there is no predecessor
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetPredecessors
| public virtual GetPredecessors( | | ipiProcessOcc, |
| | ipiProcessContextForOutputOcc, |
| | oListProcessOcc) |
-
Gets the predecessors (process occurrences) of a given process occurrence.
- Parameters:
-
- ipiProcessOcc
- The process occurrence
- ipiProcessContextForOutputOcc
- The context (process reference) for the resulting occurrences
- oListProcessOcc
- The list of predecessors (process occurrences)
- Returns:
-
S_OK - if there is at least one predecessor
S_FALSE - if there is no predecessor
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetProcessOfEachScope
| public virtual GetProcessOfEachScope( | | ipiProductReference, |
| | oListProcessReferences) |
-
Gets the process reference of each scope of a given product reference.
- Parameters:
-
- ipiProductReference
- The product reference
- oListProcessReferences
- The list of process references
- Returns:
-
S_OK - if there is at least one scope
S_FALSE - if there is no scope
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetProductOfTheScope
| public virtual GetProductOfTheScope( | | ipiProcessReference, |
| | oppProductReference, |
| const | iIID | = IID_CATIPLMNavReference) |
-
Gets the product reference of the scope of a given process reference.
- Parameters:
-
- ipiProcessReference
- The process reference
- oppProductReference
- The product reference of the scope
- iIID
- The IID of the interface representing the product reference
Legal values: Any interface implemented on a product reference (IID_CATIPLMNavReference by default)
- Returns:
-
S_OK - if there is a scope
S_FALSE - if there is no scope
E_INVALIDARG - for an invalid argument
E_NOINTERFACE - if the requested interface is not implemented on the resulting object
E_FAIL - if the method fails for any other reason
o GetProductOfTheScope
| public virtual GetProductOfTheScope( | | ipiProcessReference, |
| | iLoadMode, |
| | opProductOrPartReference) |
-
Load the target (Product/EBOM) that are linked through scope to the process
- Parameters:
-
- ipiProcessReference
- Process reference on which the scoped targets are needed to be retrieved.
- iLoadMode
- Load Mode, this is to specify loading of the targets if they are not available in the session, already.
Valid inputs: (default NO LOAD)
0 = NoLoad
1 = TargetOnly
2 = WithChildren
- opProductOrPartReference
- Part or Product reference loaded in the session.
In case of iLoadMode = No Load, this will be NULL if the target is not available in the session.
- Returns:
-
S_OK - On Success
E_FAIL - On Failure
o GetSuccessors
| public virtual GetSuccessors( | | ipiProcessInst, |
| | ipiProcessContextForOutputOcc, |
| | oListProcessOcc) |
-
Gets the successors (process occurrences) of a given process instance.
- Parameters:
-
- ipiProcessInst
- The process instance
- ipiProcessContextForOutputOcc
- The context (process reference) for the resulting occurrences
- oListProcessOcc
- The list of successors (process occurrences)
- Returns:
-
S_OK - if there is at least one successor
S_FALSE - if there is no successor
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetSuccessors
| public virtual GetSuccessors( | | ipiProcessOcc, |
| | ipiProcessContextForOutputOcc, |
| | oListProcessOcc) |
-
Gets the successors (process occurrences) of a given process occurrence.
- Parameters:
-
- ipiProcessOcc
- The process occurrence
- ipiProcessContextForOutputOcc
- The context (process reference) for the resulting occurrences
- oListProcessOcc
- The list of successors (process occurrences)
- Returns:
-
S_OK - if there is at least one successor
S_FALSE - if there is no successor
E_INVALIDARG - for an invalid argument
E_FAIL - if the method fails for any other reason
o GetWhereUsed
| public virtual GetWhereUsed( | | iProcessReference, |
| | oProcessUsingReference) |
-
Retrieve all father Process References using a given Process Reference.
Role: Retrieve from the database the list of all accessible father Process References using another Process Reference.
A father Process Reference is accessible if it meets the following conditions:
- It is an existing database object.
- It can be read under the current connection conditions (read security process granted).
- Parameters:
-
- iProcessReference
- The Process Reference
- oProcessUsingReference
- The returned father Process References list.
Must be provided as an empty List on the input;
If any Identificator returned in the list, it has to be each released;
The same parent reference will be returned MULTIPLE TIMES, if the iProcessReference is instanciated multiple times under the same parent.
- Returns:
- the returned value.
- S_OK : Returns a reference list (at least one Reference).
- S_FALSE: It does not exist any Process reference using it. Returned list is then empty.
- E_FAIL : There is some problem encountered in the API call.
- E_INVALIDARG: The input Identificator is not an existing Process Reference.
o NavigateFromPartOrPrdToProcessThroughScopeLink
| public virtual NavigateFromPartOrPrdToProcessThroughScopeLink( | | iPartorProduct, |
| | iSessionBag, |
| | oListOfProcess) |
-
This object is included in the file: DELIPPRProcessNav.h
If needed, your Imakefile.mk should include the module: DELPPRProcessItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.