All Frameworks  Class Hierarchy  This Framework  Next  Indexes

CATImmENOVIAProvider Class CATImmCAAServices

CATImmCAAServices
 

Usage: you must use this class as is. You should never derive it.


public class CATImmCAAServices

This class allows filtering the explore windows of a PRC by a LCA configuration Handler.
Role: This class allows filtering the explore windows of a PRC by a LCA configuration Handler.


Method Index


o GetAllPRCConfigHandlers(CATUnicodeString&,CATListOfCATUnicodeString&)
Return all ConfigHandlers associated with the PRC.
o GetCurrentRootIdentifiers(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATUnicodeString&)
Retreive the current root identifier from the current VPM navigator Window.
o GetCurrentRootType(CATUnicodeString&)
Retreive the current root type from the current VPM navigator Window.
o GetPRCConfigFilter(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
o GetPRCConfigHandler(CATUnicodeString&,CATUnicodeString&)
Return the current ConfigHandler applied to the PRC.
o OpenSearchResultWindow(CATUnicodeString&,CATListOfCATUnicodeString&,int,CATListOfCATUnicodeString*)
Open a search result window.
o SetPRCConfigFilter(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
o SetPRCConfigHandler(CATUnicodeString&,CATUnicodeString&,int&,int&)
Set a ConfigHandler and specify the Expand level.

Methods


o GetAllPRCConfigHandlers
public static HRESULT GetAllPRCConfigHandlers( const CATUnicodeString& iPRCName,
CATListOfCATUnicodeString& oCHNames)
Return all ConfigHandlers associated with the PRC.
Role:
Read all the Configuration Handlers associated to a given PRC and that may be used for filtering the PRC. At a time there may be many Configuration Handlers associated with PRC. This API will return all of them.
Parameters:
iPRCName
The name of the object (PRC) on which to apply filter
oCHNames
The names of the config handlers associated with the PRC.
Returns:
  • S_OK : When identifiers can be retrieved.
  • E_FAIL: Returned in case of an error.
o GetCurrentRootIdentifiers
public static HRESULT GetCurrentRootIdentifiers(CATListOfCATUnicodeString& oIdentifierNames,
CATListOfCATUnicodeString& oIdentifierValues,
CATUnicodeString& oRootType)
Retreive the current root identifier from the current VPM navigator Window.
Role:
Root identifier may be used for purpose of knowing the root ids & is further used for setting its filter.
Parameters:
oIdentifierNames
The identification of the root object (if any)
e.g.: For an “PRODUCT” object of VPMProductRootClass class it contains only one identifier ”V_ID”.
oIdentifierValues
The identifier of the root object.
e.g.: For an “PRODUCT” object of VPMProductRootClass class there is only one string whose value is the ”V_ID” value of the object.
Returns:
  • S_OK : if the filter capability is enabled and if such a root object exists.
  • E_FAIL: returned in case of many errors, comprising current activated window is not VPMNav window, as well no connection with server.
o GetCurrentRootType
public static HRESULT GetCurrentRootType(CATUnicodeString& oRootType)
Retreive the current root type from the current VPM navigator Window.
Role:
Root type may be used to interpret identifiers.
Parameters:
oRootType
The type of the root identifier
The Filter Type is basically the type of the object it is tied upon. The string is returned that way:
e.g. For a filter on a VPMProductRootClass object of the PRODUCT domain: ”CustomDomain/ENOVIA_VPMRootProductClass” where first part of the string is the customization domain (here “CustomDomain”) and could be PRODUCT, the second part of the string is the product modeler type.
Returns:
  • S_OK : if the filter capability is enabled and if such a root object exists.
  • E_FAIL: returned in case of many errors, comprising current activated window is not VPMNav window, but as well no connection with server.
o GetPRCConfigFilter
public static HRESULT GetPRCConfigFilter( const CATListOfCATUnicodeString& iPRCIdentifiersNames,
const CATListOfCATUnicodeString& iPRCIdentifiersValues,
CATListOfCATUnicodeString& oCHdsNames,
CATListOfCATUnicodeString& oCHdsValues)
Deprecated:
V5R18 CATImmCAAServices#GetPRCConfigFilter Use CATImmCAAServices.GetAllPRCConfigHandlers instead. Read the Configuration Handlers that may then be used for filtering.
Role:
The way to designate the filter, is the way to designate the object it refers to. Configuration Handlers are designated by a identifier (”ID”).
Parameters:
iPRCIdentifiersNames
The identifier name of the object on which to apply filter
This is a PRC whose identifier attribute is only V_ID.
iPRCIdentifiersValues
The identifier value of the object on which to apply filter
oCHIdsNames
The identifier names of the config handlers associated with the PRC.
The first identifier (ID) will be returned.
oCHIdsValues
The identifier values of the config handler.
Returns:
  • S_OK : when identifiers can be retrieved (even if NULL string).
  • E_FAIL: returned in case of an error.
o GetPRCConfigHandler
public static HRESULT GetPRCConfigHandler( const CATUnicodeString& iPRCName,
CATUnicodeString& oCHName)
Return the current ConfigHandler applied to the PRC.
Role:
Read the Current Configuration Handler that is currently set for the PRC. At a time there could be more than one Configuration Handlers associated with PRC but only one is active. This API will return the same.
Parameters:
iPRCName
The name of the object (PRC) on which to apply filter.
oCHName
The name of the current config handler applied to the PRC.
Returns:
  • S_OK : When config handler can be retrieved.
  • E_FAIL: Returned in case of an error.
o OpenSearchResultWindow
public static HRESULT OpenSearchResultWindow( const CATUnicodeString& iType,
const CATListOfCATUnicodeString& iAttrNameList,
const int iNb,
const CATListOfCATUnicodeString* iArrayValueList)
Open a search result window.
Role:
The way to retrieve Objects saved in Enovia through a Search Result...
Parameters:
iType
The object type follows this format {CustomDomain}/{Object type}. e.g. For a VPMProductRootClass object of the PRODUCT domain: ”CustomDomain/ENOVIA_VPMRootProductClass” where first part of the string is the customization domain (here “CustomDomain”) and could be PRODUCT, the second part of the string is the product modeler type.
iAttrNameList
List of the attribute names describing an object.For example, a DR is described with the attributes V_Id and V_version
iNb
Number of attribute sets.
iAttrValueList
The dimension of this array is iNb. In each CATListOfCATUnicodeString, you define the list of values for the set of attributes defined in iAttrNameList. The number of values in this list is equal to the number of attributes in iAttrNameList.
Returns:
  • S_OK : When everything is OK
  • E_FAIL:
o SetPRCConfigFilter
public static HRESULT SetPRCConfigFilter( const CATListOfCATUnicodeString& iPRCIdentifiersNames,
const CATListOfCATUnicodeString& iPRCIdentifiersValues,
const CATListOfCATUnicodeString& iCHIdsNames,
const CATListOfCATUnicodeString& iCHIdsValues)
Deprecated:
V5R18 CATImmCAAServices#SetPRCConfigFilter Use CATImmCAAServices.SetPRCConfigHandler instead. Set the Configuration Handler used for filtering.
Role:
The way to designate the filter, is the way to designate the object it refers to. Configuration Handlers are designated by an identifier (”ID”).
Parameters:
iPRCIdentifiersNames
The identifier of the object on which to apply filter
This is a PRC whose identifier attribute is only V_ID.
iPRCIdentifiersValues
The identifier value of the PRC on which to apply filter
iCHIdsNames
The identifier names of the config handler to be currently set.
The first identifier (ID) is used in the list to designate the config handler.First identifier may be a NULL string, then it means that Config Filter is set to NULL.
iCHIdsValues
The identifier values of the config handler to be currently set.
Returns:
  • S_OK : when identifiers can be retrieved and associated to such Filter object (if NULL string).
  • E_FAIL: returned in case of many errors, current activated window is not VPMNav window, but as well no connection with server or more than one config handler being set on a PRC.
o SetPRCConfigHandler
public static HRESULT SetPRCConfigHandler( const CATUnicodeString& iPRCName,
const CATUnicodeString& iCHName,
const int& iExpandLevel=0,
const int& iCheckFlag=0)
Set a ConfigHandler and specify the Expand level.
Role:
Set the Configuration Handler on the PRC and expand the product assembly up to given expand level. This method also checks whether Configuration Handler is actually attached to PRC based on check flag passed to the method.
Parameters:
iPRCName
The name of the object (PRC) on which to apply filter
iCHName
The name of the config handler to be currently set.
iExpandLevel
Level up to which to expand PS after applying CH. Default is 0 which means collapsed.
iCheckFlag
Flag to check whether CH was applied on the PRC. Default in No check (for better performance)
Returns:
  • S_OK : Successful execution
  • E_FAIL: If iCheckFlag equals 1 and the ConfigHandler is not actually associated to the PRC
  • E_FAIL: Returned in case of many errors, current activated window is not VPMNav window, but as well no connection with server or config handler not set on a PRC.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.