All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectSpecsModeler Interface CATIReplace

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

Usage: you can reimplement this interface by deriving the supplied CATSpecReplaceExt. adapter class.


interface CATIReplace

Interface to replace the valuation of an attribute by another one.

BOA information: this interface can be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o IsElementValidForReplace(CATUnicodeString&,CATBaseUnknown_var&,CATUnicodeString&,int&,CATBaseUnknown_var&)
Determines whether the candidate element is allowed to replace the existing one.
o Replace(CATUnicodeString&,CATBaseUnknown_var&,CATBaseUnknown_var&)
Valuates a given attribute with another object.

Methods


o IsElementValidForReplace
public virtual HRESULT IsElementValidForReplace( const CATUnicodeString& iName,
const CATBaseUnknown_var& iElement,
CATUnicodeString& oMessage,
int& oElementValidity,
const CATBaseUnknown_var& iOldValue=NULL_var)=0
Determines whether the candidate element is allowed to replace the existing one.
Parameters:
iName
name of the attribute whose value is to be replaced.
iElement
candidate element for replace.
oMessage
explains returned HRESULT
oElementValidity
Legal values : 0 if element is not valid ,
1 if element is valid
iOldValue
position of the feature to replace if the attribute is a list.
Returns:
HRESULT
Legal values : S_OK E_FAIL E_NOTIMPL
o Replace
public virtual HRESULT Replace( const CATUnicodeString& iName,
CATBaseUnknown_var& iElement,
const CATBaseUnknown_var& old_value=NULL_var )=0
Valuates a given attribute with another object.
Parameters:
iName
name of the attribute whose value is to be replaced
iElement
candidate element for replace.
iOldValue
position of the feature to replace if the attribute is a list.
Returns:
HRESULT
Legal values : S_OK E_FAIL E_NOTIMPL

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

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