All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamSupportFilter

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

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


interface CATISamSupportFilter

This interface allows to overload the behavior of the support filter in the Analysis Data creation command.
To achive this aim, this interface will have to be implemented for the late type of the created analysis data.

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 GetNLSid(CATBaseUnknown*,CATString&)
This method allows to define the NLS name that will appear in the support frame.
o GetSelectableObject(CATPathElement*,CATBaseUnknown*&,CATBaseUnknown*&)
This method returns consistent data for the support definition of the implementing Analysis Data.
o GetStatus(CATPathElement*)
This method checks if the given PathElement contains an object that could be used as support for the implementing Analysis Data.
o ValidateSupport(CATBaseUnknown*,CATBaseUnknown*)
This method allows specific Check for IDL validation.

Methods


o GetNLSid
public virtual HRESULT GetNLSid( const CATBaseUnknown* iLinkable,
CATString& oNLSid) = 0
This method allows to define the NLS name that will appear in the support frame.
Parameters:
iLinkable
The selected support
oNLSid
The NLS ID for the selected object. The ID for the plural form should be oNLSid_s
Returns:

Legal values:
  • E_FAIL, No proposal for the selected element.
  • S_OK, One proposal returned.
o GetSelectableObject
public virtual HRESULT GetSelectableObject(CATPathElement* iPath,
CATBaseUnknown*& oLinkable,
CATBaseUnknown*& oSpecObject) = 0
This method returns consistent data for the support definition of the implementing Analysis Data.
Parameters:
iPath
PathElement which is scanned to find consistent support entity.
oLinkable
[out , CATBaseUnknown#Release] if not NULL, datum that will be used to define a support.
See also:
CATISamAnalysisSupport
oSpecObject
[out , CATBaseUnknown#Release] entity that will be used to define a support.
See also:
CATISamAnalysisSupport
Returns:
S_FALSE, if the given Path contains no onsistent data. else S_OK.
o GetStatus
public virtual CATBoolean GetStatus(CATPathElement* iPath) = 0
This method checks if the given PathElement contains an object that could be used as support for the implementing Analysis Data.
WARNING The treatment of this method has to be fast, because it will be used for pre hilighting.
Parameters:
iPath
PathElement which is scanned to find consistent support entity.
Returns:
TRUE if an autorized datum has been found in the given Path.
o ValidateSupport
public virtual HRESULT ValidateSupport( const CATBaseUnknown* iLinkable,
const CATBaseUnknown* iSpecObject) = 0
This method allows specific Check for IDL validation.
Parameters:
iLinkable
The pointed Object of the connector
iSpecObject
The positionning Object of the connector
See also:
CATISamAnalysisSupport
Returns:

Legal values:
  • E_FAIL, Invalid Support.
  • S_OK, Valid Support.

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

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