DELPPRSystemItf Interface DELIPPRSystemOccAuth

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


interface DELIPPRSystemOccAuth

Interface to manage System Occurrences.


Method Index


o FromOccurrenceToPathOfInstances(CATIPLMNavOccurrence*,CATListPtrCATIPLMNavInstance&)
Computes the path of instances corresponding to a given occurrence.
o GetOccurrence(CATIPLMNavOccurrence*,CATListPtrCATIPLMNavInstance&,CATIPLMNavOccurrence*&)
Computes an occurrence corresponding to a given path of instances in a given context.
o GetOrCreateRootOccurrence(CATIPLMNavReference*,CATIPLMNavOccurrence*&)
Computes the root occurrence corresponding to a given root reference.
o Synchronize(CATIPLMNavOccurrence*)
Synchronizes an occurrence tree with respect to the model events stored in the current transaction.

Methods


o FromOccurrenceToPathOfInstances
public virtual FromOccurrenceToPathOfInstances( const iOccurrence,
oPathOfInstances)
Computes the path of instances corresponding to a given occurrence.
Parameters:
iOccurrence
The occurrence.
oPathOfInstances
The computed path of instances.
Returns:
S_OK if the methods succeeds and the occurrence has been retrieved.
E_INVALIDARG if provided arguments are unexpected.
E_FAIL otherwise.
o GetOccurrence
public virtual GetOccurrence( const iRootOccurrence,
const iPathOfInstances,
oOccurrence)
Computes an occurrence corresponding to a given path of instances in a given context.
Parameters:
iRootOccurrence
The context : a root occurrence.
iPathOfInstances
The path of instances.
oOccurrence
The computed occurrence.
Returns:
S_OK if the methods succeeds and the occurrence has been retrieved.
E_INVALIDARG if provided arguments are unexpected.
E_FAIL otherwise.
o GetOrCreateRootOccurrence
public virtual GetOrCreateRootOccurrence( const iRootReference,
oRootOccurrence)
Computes the root occurrence corresponding to a given root reference.
Parameters:
iRootReference
A root reference.
oRootOccurrence
The computed root occurrence
Returns:
S_OK if the methods succeeds and the root occurrence has been retrieved.
E_INVALIDARG if provided arguments are unexpected.
E_FAIL otherwise.
o Synchronize
public virtual Synchronize( const iRootOccurrence)
Synchronizes an occurrence tree with respect to the model events stored in the current transaction.
Parameters:
iRootOccurrence
The root occurrence.
Returns:
S_OK if the synchronization succeeds.
E_FAIL otherwise.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.