CATPLMUpdateUseItf CATPLMUpdateActorADP

Usage: you can derive this class.

public class CATPLMUpdateActorADP

Adaptor for CATIPLMUpdateActor.
Any implementation of this interface must derive from this adaptor.

Constructor and Destructor Index

o CATPLMUpdateActorADP()

Constructs an empty CATPLMUpdateActorADP.

o ~CATPLMUpdateActorADP()

Method Index

o GetErrorInCycleBehavior(ErrorInCycleBehavior&)

Returns the behavior of this actor in case the update fails (with an error).

o GetInDependencies(CATListValCATBaseUnknown_var&,CATListOfInt&)

Retrieves the list of IN dependencies of this actor.

o GetOtherLoadDependencies(CATListValCATBaseUnknown_var&,CATListOfInt&,LoadDepType&)

Retrieves the list of Load dependencies of this actor.

o GetOtherRelatedActors(CATListValCATBaseUnknown_var&,CATListOfInt&)

Retrieves the list of Other related actors of this actor.

o GetOutDependencies(CATListValCATBaseUnknown_var&,CATListOfInt&)

Retrieves the list of OUT dependencies of this actor.

o GetPLMComponentsPotentiallyModifiedByUpdate(CATListValCATBaseUnknown_var&)

Returns all PLM components on which write rights could be needed for update.

o GetPLMStaticErrors(CATUnicodeString&)

Retrieves a static error or a static warning.

o GetUnitStatus(CATPLMUpdateStatus&)

Retrieves unit status of this actor.

o GetVisibility(ActorVisibility&)

Retrieves the visibility of this actor.

o IsActive(int&)

Retrieves the activity of this actor.

o UnitPLMUpdate(CATUnicodeString&)

Updates this actor unitarily.

Constructor and Destructor

Constructs an empty CATPLMUpdateActorADP.

Methods

Returns the behavior of this actor in case the update fails (with an error).
Role: This method returns the behavior of this actor in case it is in a complex node, and its update fails. In some case, other actors of the same complex node need to be updated first so that the update of the current actor succeeds, so we allow the current actor to have its update fail once.
Default Behavior: the actor is in error at the first failed update attempt.

Parameters:

oBehavior

[out] The behavior in case of failure at update. StopAtFirst = 0 : the node and the complex node are in error when the update of an actor failed with an error. StopAtSecond = 1 : at first error, the actor is considered as out of date, and it is really in error when the update still fails at the second time in the cycle.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Retrieves the list of IN dependencies of this actor.
Role: This method retrieves a list of IN dependencies, which are actors which must be already up to date before updating this actor. Note that all the IN dependencies may not be in the returned list, as they can also be integrated in the update graph through their own GetOutDependencies for example.
Default Behavior: the default behavior of this method is to append nothing in the output list oDep.

Parameters:

oDep

[out] The list of IN dependencies. Those elements should adhere either to CATIAssemblyUpdateActor, or to CATIPLMUpdateActor.

oListOfLoadMode

[out] The list of load mode in which the dependency must be, associated to oDep. PLMMode = 0, VisuMode = 1, LinkableMode = 2, EditMode = 3, DMUMode = 4, UVMode = 5.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Retrieves the list of Load dependencies of this actor.
Role: This method retrieves a list of Load dependencies, which are actors which need to be loaded before this actor is updated.
Default Behavior: the default behavior of this method is to append nothing in the output list oDep.

Parameters:

oDep

[out] The list of Load dependencies. Those elements should adhere either to CATIAssemblyUpdateActor, or to CATIPLMUpdateActor.

oListOfLoadMode

[out] The list of load mode in which the dependency must be, associated to oDep. PLMMode = 0, VisuMode = 1, LinkableMode = 2, EditMode = 3, DMUMode = 4, UVMode = 5.

oType

[out] The load type. Direct: the load dependencies are loaded before this actor is updated. DispatchIn: the load dependencies are loaded before any IN dependency of this actor is updated DispatchOut: the load dependencies are loaded before any OUT dependency of this actor is updated

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Retrieves the list of Other related actors of this actor.
Role: This method retrieves a list of Other related actors, which are neither IN, OUT nor LOAD dependencies of this actor. It may be useful to prepare caches of these related actors.
Default Behavior: the default behavior of this method is to append nothing in the output list oDep.

Parameters:

oDep

[out] The list of Other related actors. Those elements should adhere either to CATIAssemblyUpdateActor, or to CATIPLMUpdateActor.

oListOfLoadMode

[out] The list of load mode in which the related actor must be, associated to oDep. PLMMode = 0, VisuMode = 1, LinkableMode = 2, EditMode = 3, DMUMode = 4, UVMode = 5.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Retrieves the list of OUT dependencies of this actor.
Role: This method retrieves a list of OUT dependencies, which are actors which need that is actor is up to date before being updated. Note that most OUT dependencies already declared this actor as an IN dependency, and they do not need to be declared as OUT dependencies again. This method only needs to return OUT dependencies corresponding to actors which has not declared this actor as an IN dependency.
Default Behavior: the default behavior of this method is to append nothing in the output list oDep.

Parameters:

oDep

[out] The list of OUT dependencies. Those elements should adhere either to CATIAssemblyUpdateActor, or to CATIPLMUpdateActor.

oListOfLoadMode

[out] The list of load mode in which the dependency must be, associated to oDep. PLMMode = 0, VisuMode = 1, LinkableMode = 2, EditMode = 3, DMUMode = 4, UVMode = 5.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Returns all PLM components on which write rights could be needed for update.
Role: This method must return every PLM components that may be modified by the update of this CATIPLMUpdateActor. If a PLM component is not returned, that means that this PLM component is never modified by the update of this CATIPLMUpdateActor, whatever its state.
Default Behavior: the default behavior of this method is to append nothing in the output list oComponentsList.

Parameters:

ioComponentsList

[inout] The list in which every components on which write rights could be needed will be added.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Retrieves a static error or a static warning.
Role: In case the update returns a status in warning or in error even before being updated, the static warning or error can be retrieved using this method.
Default Behavior: no default behavior for this method : it would fail.

Parameters:

oDisplayedError

[out] In case the status is in error or in warning, this is the static error or warning to be displayed to the user.

Returns:

S_OK if there is one error (oDisplayedError is valued), S_FALSE if there is one warning but no error (oDisplayedError is valued), E_FAIL if there is neither error nor warning. E_UNEXPECTED if an unexpected error occurs.

Retrieves unit status of this actor.
Role: This method retrieves the PLM Update unit status of this actor.
Default Behavior: by default, the returned status is "Up to Date".

Parameters:

oUnitStatus

[out] The unit status of this actor.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Retrieves the visibility of this actor.
Role: This method returns the visibility of this actor. If the actor is visible, it will appear in its own simple node in the update graph in the update assistant. If it is not visible, it will not appear in the graph but it will still appear in the detailed list below the graph when its complex node is selected.
Default Behavior: the actor is not visible by default.

Parameters:

oVisibility

[out] The visibility of the actor: 0 = NeverVisible, 1 = VisibleInList, 2 = AlwaysVisible.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Retrieves the activity of this actor.
Role: This method returns the activity of this actor. If the actor is inactive, it will not be inserted in the update graph and it will not participate to the PLM Update process.
Default Behavior: the actor is active by default.

Parameters:

oActivity

[out] The activity of the actor: 0 = inactive, 1 = active.

Returns:

S_OK if everything ran ok, E_UNEXPECTED if an unexpected error occurs.

Updates this actor unitarily.
Role: This method launches the process which will update this actor. At the end of this method, this method must be either up to date, or out of date with error (dynamic error).
Default Behavior: no default behavior for this method : it would fail.

Parameters:

oDisplayedError

[out] In case the update failed, this is the error to be displayed to the user.

Returns:

S_OK if the update succeeded and the actor should be up to date now, E_FAIL if a dynamic error occured, in which case oDisplayedError is valued. E_UNEXPECTED if an unexpected error occurs.

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