All Frameworks Class Hierarchy This Framework Indexes
CATPDMReconcile Class CATEpeObject
Usage: you must use this class as is. You should never derive it.
public class CATEpeObject
CATIA Object to be reconciled with its representation in VPDM Repository.
Role:
CATIA Object to be reconcile with its representation in VPDM Repository.
It could represent either a CATIA document or an ASM_Product.
A typical definition of a reconciliation rule on an object is made of following steps
- Select and sets one Environment among authorized one for this object.
- Select and execute on Criterion among authorized one for this object.
- Select on Criterion result one PDM Object (is object will not be saved as new object).
- Define reconciliation rule to be applied among authorized reconciliation rule.
- See also:
- CATEpeSession
Method Index
- o
ExecuteCriterion(CATUnicodeString&)
- Executes the current Criterion.
- o
ExecuteCriterion(CATListValCATUnicodeString&)
- Executes the current Criterion queries.
- o
GetAttributeColumnNameList(CATListValCATUnicodeString&)
- Gets list of PDM attributes in the result of the execution of current Criterion.
- o
GetCharacteristicDetail(int,CATListValCATUnicodeString&,CATListValCATUnicodeString&)
- Get detailed view of characteristics values.
- o
GetCharacteristicList(CATLISTP(CATIPDMCharacteristicScm)&)
- Gets list of authorized Characteristic for this object.
- o
GetCharacteristicStatus(int,CATUnicodeString&)
- Get status of a characteristic.
- o
GetCriteriaList(CATLISTP(CATIPDMCriterionScm)&)
- Gets List of criteria applicable for this object for a given environment.
- o
GetCurrentCriterion(CATIPDMCriterionScm**)
- Gets current Criterion on this object.
- o
GetEnvironment(CATUnicodeString&)
- Gets the Environment selected.
- o
GetExposedEntity()
- Access to object reconciliator internal object.
- o
GetExposedEntity(CATScmObject*)
- Access to CAA reconciliator object from other reconciliator objects.
- o
GetGenericReconciliationId(CATBaseUnknown**)
- Gets underlying CATIA object.
- o
GetPDMObject(CATScmPDMObject*&)
- Gets the Selected PDM Object amongst the PDM objects retrieved through the ExecuteCriterion.
- o
GetPDMObjectList(CATListPtrCATScmPDMObject&)
- Gets list of PDM objects result of the execution of current Criterion.
- o
GetRule()
- Gets the reconcilation rule selected.
- o
GetStatus()
- Gets Rule status of an object.
- o
GetStorageMode()
- Gets storage mode.
- o
IsCharacteristicComputed(int,int&)
- Test if a characteristics is already computed.
- o
IsDocument()
- Indicates whether the given object is an encapsulation over the CATDocument or not.
- o
IsPart()
- Indicates whether the given object is an encapsulation over the CATIProduct or not.
- o
IsProxyDocument()
- Indicates whether the given object is a document not loaded.
- o
IsRuleValid(CATEpeSession::CATReconcileRule,CATBoolean&)
- Checks that a reconcilation rule could be used on one object.
- o
ResetExecuteCriterion()
- Resets Execute Criterion results.
- o
SetEnvironment(CATUnicodeString&)
- Defines Environment where this object need to be stored.
- o
SetPDMObject(CATScmPDMObject*)
- Sets the Selected PDM Object amongst the PDM objects retrieved through the ExecuteCriterion.
- o
SetRule(CATEpeSession::CATReconcileRule)
- Sets the reconcilation rule to be applied.
- o
SetStorageMode(CATEpeSession::CATStorageMode)
- Sets storage mode.
Methods
o ExecuteCriterion
| public ExecuteCriterion( | | icQueryXML) |
-
Executes the current Criterion.
Role: Executes against VPDM repository the current Criterion query which
is a XML mode criterion.
Precondition: Assumes that oPDMObjList address should be passed
on as built objects, to be letft as it is
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- icQueryXML
- Criterion parameters to be used to Execute criterion.
Legal values: If XML stream is empty, we will recompute parameters from default values ( @see CATIPDMCriterionScm::GetCriterionParametersXML ).
o ExecuteCriterion
| public ExecuteCriterion( | | iQueryValueList) |
-
Executes the current Criterion queries.
Role: Executes against VPDM repository the current Criterion query which
is a old mode criterion based on list of attributes.
Precondition: Assumes that oPDMObjList address should be passed
on as built objects, to be letft as it is
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- iQueryValueList
- Optional list of value for a query
o GetAttributeColumnNameList
| public GetAttributeColumnNameList( | | oAttrColNames) |
-
Gets list of PDM attributes in the result of the execution of current Criterion.
Role: Gets list of PDM attributes in the result of the execution of current Criterion.
Precondition: Assumes that oAttrColNames address should be passed
on as built objects, only need to be emptied by RemoveAll.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- oAttrColNames
- List of attribute names readed in VPDM repository.
o GetCharacteristicDetail
| public GetCharacteristicDetail( | | inChar, |
| | olstCatia, |
| | olstPdm) |
-
Get detailed view of characteristics values.
Role: Get detailed view of characteristics values.
ie detail comparison results for this characteristics between the object in
CATIA session and the one selected on VPDM repository (
CATIPDMCharacteristicScm ).
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- inChar
- Characteristic (
GetCharacteristicList)
- olstCatia
- List of characteristics on CATIA side
- olstPdm
- List of characteristics on PDM side
o GetCharacteristicList
| public GetCharacteristicList( | | oCharList) |
-
Gets list of authorized Characteristic for this object.
Role: Gets list of authorized Characteristic for this object.
(
CATIPDMCharacteristicScm ).
Precondition: Assumes that oCharList address should be passed
on as built objects, only need to be emptied by RemoveAll.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- oCharList
- List of Characteristic (
CATIPDMCharacteristicScm ).
o GetCharacteristicStatus
| public GetCharacteristicStatus( | | inChar, |
| | ocStatus) |
-
Get status of a characteristic.
Role: Get status of a characteristic.
ie global comparison status for this characteristics between the object in
CATIA session and the one selected on VPDM repository (
CATIPDMCharacteristicScm ).
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- inChar
- Characteristic (
GetCharacteristicList)
- ocStatus
- List characteristic’s status
o GetCriteriaList
| public GetCriteriaList( | | ioCriteriaList) |
-
Gets List of criteria applicable for this object for a given environment.
Role: Gets List of criteria applicable for this object for a given environment.
Precondition: Assumes that the address of an already
built CATLISTP(CATIPDMCriterion) is passed.
Postcondition: RemoveAll to be called by the caller on the list obtained.
Postcondition: All ready built list(object) to be passed.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- ioCriteriaList
- List of authorized Criteria.
o GetCurrentCriterion
| public GetCurrentCriterion( | | oCrit) |
-
Gets current Criterion on this object.
Role: Gets current Criterion on this object.
Postcondition: Release on the interface required by the caller.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- oCrit
- Criterion.
o GetEnvironment
| public GetEnvironment( | | ocEnv) |
-
Gets the Environment selected.
Role: Gets the Environment selected for this object.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- ocEnv
- Environment. (@set CATEpeSession)
o GetExposedEntity
| public GetExposedEntity( | ) |
-
Access to object reconciliator internal object.
Role: Access to object reconciliator internal object..
- Returns:
- Method return code
Legal values: Returns NULL if one error occur, otherwise provide access
associated CATScmObject.
o GetExposedEntity
| public static GetExposedEntity( | const | ixObj) |
-
Access to CAA reconciliator object from other reconciliator objects.
Role: Access to CAA reconciliator object from other reconciliator objects.
- Returns:
- Method return code
Legal values: Returns NULL if one error occur, otherwise provide access
associated CATEpeObject.
- Parameters:
-
- ixObj
- Internal session entity.
o GetGenericReconciliationId
| public GetGenericReconciliationId( | | oRecObj) |
-
Gets underlying CATIA object.
Role: Gets underlying CATIA object.
Postcondition: Interface to be released by the caller.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- oRecObj
- [out, CATBaseUnknown#Release] CATIA object.
o GetPDMObject
| public GetPDMObject( | | oPDMObj) |
-
Gets the Selected PDM Object amongst the PDM objects retrieved through the ExecuteCriterion.
Role: Gets the Selected PDM Object amongst the PDM objects retrieved through the ExecuteCriterion.(
CATScmPDMObject ).
Postcondition: Not to be deleted by the caller as reference is set.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- oPDMObj
- PDM object.
o GetPDMObjectList
| public GetPDMObjectList( | | oPDMObjList) |
-
Gets list of PDM objects result of the execution of current Criterion.
Role: Gets list of PDM objects result of the execution of current Criterion.
Precondition: Assumes that oPDMObjList address should be passed
on as built objects, should be left as it is.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- oPDMObjList
- List of VPDM objects that fullfil request (
CATScmPDMObject ).
o GetRule
-
Gets the reconcilation rule selected.
Role: Gets the reconcilation rule selected.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- oRule
- Reconciliation rule type (@set CATEpeSession)
o GetStatus
-
Gets Rule status of an object.
Role: Gets rule status of an object among authorized status.
- Returns:
- Object status among authorized status.
o GetStorageMode
-
Gets storage mode.
Role: Gets storage mode to be applied for this object.
If storage mode has not been selected a default will be computed.
- Returns:
- Storage mode selected. (@set CATEpeSession)
o IsCharacteristicComputed
| public IsCharacteristicComputed( | | inChar, |
| | olComputed) |
-
Test if a characteristics is already computed.
Role: Test if a characteristics is already computed (
CATIPDMCharacteristicScm ).
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- inChar
- Characteristic (
GetCharacteristicList)
- olComputed
- Define is this Characteristic has already been computed
o IsDocument
-
Indicates whether the given object is an encapsulation over the CATDocument or not.
Role: Indicates whether the given object is an encapsulation over the CATDocument or not.
- Returns:
- A boolean value.
Legal values:
- TRUE if Object is a document.
- FALSE otherwise.
o IsPart
-
Indicates whether the given object is an encapsulation over the CATIProduct or not.
Role: Indicates whether the given object is an encapsulation over the CATIProduct or not.
- Returns:
- A boolean value.
Legal values:
- TRUE if Object is a part.
- FALSE otherwise.
o IsProxyDocument
-
Indicates whether the given object is a document not loaded.
Role: Indicates whether the given object is a document not loaded.
- Returns:
- A boolean value.
Legal values:
- TRUE if Object is a document not loaded.
- FALSE otherwise.
o IsRuleValid
| public IsRuleValid( | | iRule, |
| | oResult) |
-
Checks that a reconcilation rule could be used on one object.
Role: Checks that the reconcilation rule could be used on one object.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- iRule
- Reconciliation rule type (
CATReconcileRule)
- oResult
- Indicates if rule could be used on this object. It is object and context dependant.
Legal values:
- TRUE if Rules could be used for this object.
- FALSE otherwise.
o ResetExecuteCriterion
| public ResetExecuteCriterion( | ) |
-
Resets Execute Criterion results.
Role: Suppress all Execute Criterion results.
o SetEnvironment
| public SetEnvironment( | const | iEnv) |
-
Defines Environment where this object need to be stored.
Role: Defines Environment where this object need to be stored.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- iEnv
- String defining the Environment.
Legal values: Could be found using
CATEpeSession.GetEnvironments.
o SetPDMObject
| public SetPDMObject( | | iPDMObj) |
-
Sets the Selected PDM Object amongst the PDM objects retrieved through the ExecuteCriterion.
Role: Sets the Selected PDM Object amongst the PDM objects retrieved through the ExecuteCriterion.(
CATScmPDMObject ). This PDM object will be found as result of a Criterion execution
(
ExecuteCriterion).
Warning: This method allocate a new CATScmPDMObject.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- iPDMObj
- PDM object.
o SetRule
-
Sets the reconcilation rule to be applied.
Role: Sets the reconcilation rule to be applied for this object.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- iRule
- Reconciliation rule type (@set CATEpeSession)
o SetStorageMode
| public SetStorageMode( | | inMode) |
-
Sets storage mode.
Role: Sets storage mode to be applied for this object.
- Returns:
- Method return code
Legal values: Returns S_OK if operation runs well.
- Parameters:
-
- inMode
- Storage mode selected. (@set CATEpeSession)
This object is included in the file: CATEpeObject.h
If needed, your Imakefile.mk should include the module: CATPDMReconcileModel