All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisResources Class CATEAnalysisSupportFilter

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

Usage: you can derive this class.


public class CATEAnalysisSupportFilter

Adapter for the implementation of CATISamSupportFilter interface.
It can be used for AnalysisEntity or AnalysisSet.

See also:
CATISamSupportFilter


Constructor and Destructor Index


o CATEAnalysisSupportFilter()
o ~CATEAnalysisSupportFilter()

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.

Constructor and Destructor


o CATEAnalysisSupportFilter
public CATEAnalysisSupportFilter()
o ~CATEAnalysisSupportFilter
public virtual ~CATEAnalysisSupportFilter()

Methods


o GetNLSid
public virtual HRESULT GetNLSid( const CATBaseUnknown* iLinkable,
CATString& oNLSid)
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
o GetSelectableObject
public virtual HRESULT GetSelectableObject(CATPathElement* iPath,
CATBaseUnknown*& oLinkable,
CATBaseUnknown*& oSpecObject)
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] Represents the object to link with.
See also:
CATISamAnalysisSupport
oSpecObject
[out , CATBaseUnknown#Release] Represents the product instance.
See also:
CATISamAnalysisSupport
Returns:
E_NOTIMPL for this implementation
o GetStatus
public virtual CATBoolean GetStatus(CATPathElement* iPath)
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)
This method allows specific Check for IDL validation. (Will be introducted in R14)
Parameters:
iLinkable
The pointed Object of the connector
iSpecObject
The positionning Object of the connector
See also:
CATISamAnalysisSupport

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

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