Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

DELPPRSystemItf Interface DELIPPRSystemNav

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface DELIPPRSystemNav

Interface for navigation in the Production System model.

Method Index

o GetImplementedWorkplanOfEachScopeFromSystem(CATIPLMNavReference*,CATListPtrCATIPLMNavReference&): Gets the Workplan reference of each scope of a given System reference.
o GetImplementingSystemOfEachScopeFromWorkplan(CATIPLMNavReference*,CATListPtrCATIPLMNavReference&): Gets the System reference of each scope of a given Workplan reference.
o GetListOfAssignedOperations(CATIPLMNavReference*,CATIPLMNavReference*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&): Gets the operation occurrences that are assigned to a given process reference within a given scope.
o GetListOfAssignedOperations(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&): Gets the operation occurrences that are assigned to a given process occurrence within a given scope.
o GetListOfAssignedProcesses(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&): Gets the process occurrences that are assigned to a given operation occurrence.
o GetListOfImplementedOperationsFromOperation(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&): Gets the Workplan System operation occurrences that are assigned to a given General System operation occurrence.
o GetListOfImplementingOperationsFromOperation(CATIPLMNavOccurrence*,CATIPLMNavReference*,CATIPLMNavReference*,CATListPtrCATIPLMNavOccurrence&): Gets the General System operation occurrences that are assigned to a given Workplan System operation occurrence within a given scope.
o GetMaterialFlowSystemsFrom(CATIPLMNavOccurrence*,CATListPtrCATIPLMNavOccurrence&): Gets the source (OUT) system occurrences of a given system occurrence.
o GetMaterialFlowSystemsTo(CATIPLMNavOccurrence*,CATListPtrCATIPLMNavOccurrence&): Gets the target (IN) system occurrences of a given system occurrence.
o GetProcessOfEachScope(CATIPLMNavReference*,CATListPtrCATIPLMNavReference&): Gets the process reference of each scope of a given system reference.
o GetSystemOfEachScope(CATIPLMNavReference*,CATListPtrCATIPLMNavReference&): Gets the system reference of each scope of a given process reference.
o GetWhereUsed(CATIAdpPLMIdentificator&,CATLISTP(CATIAdpPLMIdentificator)&): Retrieve all father System/Operation References using a given System/Operation Reference.

Methods

o GetImplementedWorkplanOfEachScopeFromSystem

public virtual GetImplementedWorkplanOfEachScopeFromSystem(		`ipiSystemReference`,
		`oListWorkplanReferences`)

Gets the Workplan reference of each scope of a given System reference.

Parameters:

ipiSystemReference: The system reference
oListWorkplanReferences: The list of Workplan 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 GetImplementingSystemOfEachScopeFromWorkplan

public virtual GetImplementingSystemOfEachScopeFromWorkplan(		`ipiWorkplanReference`,
		`oListSystemReferences`)

Gets the System reference of each scope of a given Workplan reference.

Parameters:

ipiWorkplanReference: The workplan reference
oListSystemReferences: The list of system 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 GetListOfAssignedOperations

public virtual GetListOfAssignedOperations(		`ipiProcessRef`,
		`ipiSystemScope`,
		`ipiSystemContextForOutputOcc`,
		`oListOperationOcc`)

Gets the operation occurrences that are assigned to a given process reference within a given scope.

Parameters:

ipiProcessRef: The process reference
ipiSystemScope: The system reference representing the scope for which the assigned operation occurrences are requested
ipiSystemContextForOutputOcc: The context (system reference) for the resulting occurrences
oListOperationOcc: The list of operation 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 GetListOfAssignedOperations

public virtual GetListOfAssignedOperations(		`ipiProcessOcc`,
		`ipiSystemScope`,
		`ipiSystemContextForOutputOcc`,
		`oListOperationOcc`)

Gets the operation occurrences that are assigned to a given process occurrence within a given scope.

Parameters:

ipiProcessOcc: The process occurrence
ipiSystemScope: The system reference representing the scope for which the assigned operation occurrences are requested
ipiSystemContextForOutputOcc: The context (system reference) for the resulting occurrences
oListOperationOcc: The list of operation 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 GetListOfAssignedProcesses

public virtual GetListOfAssignedProcesses(		`ipiOperationOcc`,
		`ipiProcessContextForOutputOcc`,
		`oListProcessOcc`)

Gets the process occurrences that are assigned to a given operation occurrence.

Parameters:

ipiOperationOcc: The operation occurrence
ipiProcessContextForOutputOcc: The context (process reference) for the resulting occurrences
oListProcessOcc: The list of process occurrences (might also be references)

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 GetListOfImplementedOperationsFromOperation

public virtual GetListOfImplementedOperationsFromOperation(		`ipiOperationOcc`,
		`ipiSystemOrOperationReferenceForOutputOcc`,
		`oListOperationOcc`)

Gets the Workplan System operation occurrences that are assigned to a given General System operation occurrence.

Parameters:

ipiOperationOcc: The operation occurrence
ipiSystemOrOperationReferenceForOutputOcc: The context (System or Operation reference) for the resulting occurrences
oListOperationOcc: The list of operation 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 GetListOfImplementingOperationsFromOperation

public virtual GetListOfImplementingOperationsFromOperation(		`ipiOperationOcc`,
		`ipiSystemScope`,
		`ipiSystemContextForOutputOcc`,
		`oListOperationOcc`)

Gets the General System operation occurrences that are assigned to a given Workplan System operation occurrence within a given scope.

Parameters:

ipiOperationOcc: The operation occurrence
ipiSystemScope: The system reference representing the scope for which the assigned operation occurrences are requested
ipiSystemContextForOutputOcc: The context (system reference) for the resulting occurrences
oListOperationOcc: The list of operation 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 GetMaterialFlowSystemsFrom

public virtual GetMaterialFlowSystemsFrom(		`ipiSystemTo`,
		`oListSystemsFrom`)

Gets the source (OUT) system occurrences of a given system occurrence.

Parameters:

ipiSystemTo: The system occurrence representing the target (IN) of a material flow
oListSystemsFrom: The list of system occurrences representing the sources (OUT) of material flows

Returns:

S_OK: if there is at least one material flow
S_FALSE: if there is no material flow
E_INVALIDARG: for an invalid argument
E_FAIL: if the method fails for any other reason

o GetMaterialFlowSystemsTo

public virtual GetMaterialFlowSystemsTo(		`ipiSystemFrom`,
		`oListSystemsTo`)

Gets the target (IN) system occurrences of a given system occurrence.

Parameters:

ipiSystemFrom: The system occurrence representing the source (OUT) of a material flow
oListSystemsTo: The list of system occurrences representing the targets (IN) of material flows

Returns:

S_OK: if there is at least one material flow
S_FALSE: if there is no material flow
E_INVALIDARG: for an invalid argument
E_FAIL: if the method fails for any other reason

o GetProcessOfEachScope

public virtual GetProcessOfEachScope(		`ipiSystemReference`,
		`oListProcessReferences`)

Gets the process reference of each scope of a given system reference.

Parameters:

ipiSystemReference: The system 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 GetSystemOfEachScope

public virtual GetSystemOfEachScope(		`ipiProcessReference`,
		`oListSystemReferences`)

Gets the system reference of each scope of a given process reference.

Parameters:

ipiProcessReference: The process reference
oListSystemReferences: The list of system 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 GetWhereUsed

public virtual GetWhereUsed(		`iSystemOrOperationReference`,
		`oSystemOrOperationUsingReference`)

Retrieve all father System/Operation References using a given System/Operation Reference.

Role: Retrieve from the database the list of all accessible father System/Operation References using another System/Operation Reference.

A father System/Operation 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:

iSystemOrOperationReference: The SystemOrOperationReference Reference
oSystemOrOperationUsingReference: The returned father SystemOrOperationReference Reference 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 iSystemOrOperationReference 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 SystemOrOperationreference 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 System/Operation Reference.

This object is included in the file: DELIPPRSystemNav.h
If needed, your Imakefile.mk should include the module: DELPPRSystemItf