CATPLMUpdateUseItf class CATEPLMUpdateActorRepContainer
Usage: you can derive this class.
public class CATEPLMUpdateActorRepContainer
Base implementation of actors that represents a representation container.
CATIPLMUpdateActor is implemeted in this file.
It provides a generic behaviour for the GetUnitStatus and UnitPLMUpdate methods.
This component must not be instanciated directly.
Constructor and Destructor Index
- o
CATEPLMUpdateActorRepContainer()
- Constructs an empty CATEPLMUpdateActorRepContainer.
- o
~CATEPLMUpdateActorRepContainer()
-
Method Index
- o
GetAlias(CATUnicodeString&)
- Get the alias of this representation container actor.
- o
GetAssociatedRepRef()
- Retrieves the associated Representation Reference.
- o
GetUnitStatus(CATPLMUpdateStatus&)
- Retrieves unit status of this actor.
- o
Init(CATBaseUnknown*,CATBaseUnknown*,CATUnicodeString)
- Initialize this container actor with the specified RepRef and container.
- o
UnitPLMUpdate(CATUnicodeString&)
- Updates this actor unitarily.
Constructor and Destructor
o CATEPLMUpdateActorRepContainer
public CATEPLMUpdateActorRepContainer( | ) |
-
Constructs an empty CATEPLMUpdateActorRepContainer.
o ~CATEPLMUpdateActorRepContainer
public virtual ~CATEPLMUpdateActorRepContainer( | ) |
-
Methods
o GetAlias
-
Get the alias of this representation container actor.
- Parameters:
-
- oAlias
- [out] The returned alias.
- Returns:
-
S_OK
if everything ran ok,
E_UNEXPECTED
if a serious error occured.
o GetAssociatedRepRef
-
Retrieves the associated Representation Reference.
- Returns:
- The pointer _associatedRepRef on the associated Representation Reference is returned.
o GetUnitStatus
-
Retrieves unit status of this actor.
Role: This method retrieves the PLM Update unit status of this actor.
Default Behavior: by default, all the features of this container are
checked and the actor is UpToDate only if all the features are 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.
o Init
-
Initialize this container actor with the specified RepRef and container.
- Parameters:
-
- iRepRef
- [in] The RepRef containing this container.
- iContainer
- [in] The container corresponding to this actor.
- iContainerType
- [in] The type name of the container. It could be retrieve from the container
but this way is more convenient as we already have this information
when calling this method.
- Returns:
-
S_OK
if everything ran ok,
E_UNEXPECTED
if a serious error occured.
o UnitPLMUpdate
-
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: by default, all the features of this container
which are out of date are updated.
- 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.
This object is included in the file: CATEPLMUpdateActorRepContainer.h
If needed, your Imakefile.mk should include the module: CATPLMUpdateUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.