All Frameworks  Class Hierarchy  This Framework  Next  Indexes

CATPDMBaseInterfaces Interface CATIAttrMappingInfo

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIAttrMappingInfo
 

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


interface CATIAttrMappingInfo

Interface to be used by user code to get the infomation regarding 1.
/ CATIA or ENOVIA part 2./ Details of attribute like name, type etc. User code will receive the pointer to CATIAttrMappingInfo in save/import process. User can query the varioue info (listed below) by using the pointer Role: This is an input interface for the user code in attribute mapping process.


Method Index


o GetAttrCXName(CATUnicodeString&)
Function used while saving the part from CATIA to ENOVIA Returns attribute name in CATIA.
o GetAttrDBName(CATUnicodeString&)
Function used while importing the part from ENOVIA to CATIA Returns attribute name in ENOVIA
o GetAttributeName(CATUnicodeString&)
Returns attribute name
o GetDBUuid(SEQUENCE(octet)&)
Function used while importing the part from ENOVIA to CATIA Returns uuid of the ENOVIA entity
o GetExistingUEAttValFromDB(CATBoolean&)
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA.
o GetExistingUEAttValFromDB(CATUnicodeString&)
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA.
o GetExistingUEAttValFromDB(double&)
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA.
o GetExistingUEAttValFromDB(int&)
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA.
o GetPartPointer(CATBaseUnknown*&)
Function used while saving the part from CATIA to ENOVIA Returns part pointer.
o GetTypeOfAttribue(CATEnoAttrMappingEnumDef::AttributeTypes&)
Returns type of attribute

Methods


o GetAttrCXName
public virtual HRESULT GetAttrCXName(CATUnicodeString& oAttrCXName) = 0
Function used while saving the part from CATIA to ENOVIA Returns attribute name in CATIA.
Parameters:
oAttrCXName
User will get name of the attribute in CATIA
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetAttrDBName
public virtual HRESULT GetAttrDBName(CATUnicodeString& oAttrDBName) = 0
Function used while importing the part from ENOVIA to CATIA Returns attribute name in ENOVIA
Parameters:
oAttrDBName
User will get name of the attribute in ENOVIA in oAttrDBName
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetAttributeName
public virtual HRESULT GetAttributeName(CATUnicodeString& oAttrName) = 0
Returns attribute name
Parameters:
oAttrName
User will get attribute name in oAttrName parameter
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetDBUuid
public virtual HRESULT GetDBUuid(SEQUENCE(octet)& oUuid) = 0
Function used while importing the part from ENOVIA to CATIA Returns uuid of the ENOVIA entity
Parameters:
oUuid
User will get uuid in oUuid
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetExistingUEAttValFromDB
public virtual HRESULT GetExistingUEAttValFromDB(CATBoolean& oValue)= 0
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA. This is an optimisation. User need not go to database to query the existing value of the ENOVIA entity. User should first query for type of attribute using the function GetTypeOfAttribue and depending on the output of GetTypeOfAttribue it should call the proper overload version of GetExistingUEAttValFromDB
Parameters:
oValue
User will get existing boolean value in ENOVIA in oValue
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetExistingUEAttValFromDB
public virtual HRESULT GetExistingUEAttValFromDB(CATUnicodeString& oValue)= 0
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA. This is an optimisation. User need not go to database to query the existing value of the ENOVIA entity. User should first query for type of attribute using the function GetTypeOfAttribue and depending on the output of GetTypeOfAttribue it should call the proper overload version of GetExistingUEAttValFromDB
Parameters:
oValue
User will get existing string value in ENOVIA in oValue
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetExistingUEAttValFromDB
public virtual HRESULT GetExistingUEAttValFromDB(double& oValue)= 0
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA. This is an optimisation. User need not go to database to query the existing value of the ENOVIA entity. User should first query for type of attribute using the function GetTypeOfAttribue and depending on the output of GetTypeOfAttribue it should call the proper overload version of GetExistingUEAttValFromDB
Parameters:
oValue
User will get existing double value in ENOVIA in oValue
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetExistingUEAttValFromDB
public virtual HRESULT GetExistingUEAttValFromDB(int& oValue)= 0
Function used while importing the part from ENOVIA to CATIA This function will return the existing value of the of the attribute in ENOVIA. This is an optimisation. User need not go to database to query the existing value of the ENOVIA entity. User should first query for type of attribute using the function GetTypeOfAttribue and depending on the output of GetTypeOfAttribue it should call the proper overload version of GetExistingUEAttValFromDB
Parameters:
oValue
User will get existing interger value in ENOVIA in oValue
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetPartPointer
public virtual HRESULT GetPartPointer(CATBaseUnknown*& opIUnkOfPart) = 0
Function used while saving the part from CATIA to ENOVIA Returns part pointer. User code then query the return pointer for neccessary information regarding part.
Parameters:
opIUnkOfPart
User will get part pointer in opIUnkOfPart
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error
o GetTypeOfAttribue
public virtual HRESULT GetTypeOfAttribue(CATEnoAttrMappingEnumDef::AttributeTypes& oAttrType) = 0
Returns type of attribute
Parameters:
oAttrType
User will get attribute type in oAttrType parameter
Returns:
HRESULT Error code of function. S_OK : Success E_FAIL : Error

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

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