All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisContext

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

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


interface CATISamAnalysisContext

Interface to define the usage context of an application based on CATISAMWorkshop.
Role: Two contexts to customize an Analysis Workshop:


Method Index


o GetContext(CATSamAnalysisContext&)
Retrieves the context of the CATAnalysis document.
o GetContext(CATString&)
Retrieves the context of the Workshop.
o GetVisuModes(CATSamVisuMode&,CATSamVisuMode&)
Retrieves the default and global context visualization mode.
o SetContext(CATSamAnalysisContext&)
Sets the context of the CATAnalysis document.
o SetContext(CATString&)
Sets the context of the Workshop.
o SetVisuModes(CATSamVisuMode,CATSamVisuMode,CATBoolean,CATBoolean)
Sets the default and global context visualization mode.

Methods


o GetContext
public virtual HRESULT GetContext(CATSamAnalysisContext& oContext) = 0
Retrieves the context of the CATAnalysis document.
Parameters:
oContext
the context.
o GetContext
public virtual HRESULT GetContext(CATString& oContext) = 0
Retrieves the context of the Workshop.
Parameters:
oContext
context name.
o GetVisuModes
public virtual HRESULT GetVisuModes(CATSamVisuMode& oDefaultMode,
CATSamVisuMode& oGlobalMode) = 0
Retrieves the default and global context visualization mode.
Parameters:
oDefaultMode
the default visualization mode.
oGlobalMode
the global visualization mode.
o SetContext
public virtual HRESULT SetContext( const CATSamAnalysisContext& iContext) = 0
Sets the context of the CATAnalysis document.
Parameters:
iContext
the context.
o SetContext
public virtual HRESULT SetContext( const CATString& iContext) = 0
Sets the context of the Workshop.
Parameters:
iContext
context name.
o SetVisuModes
public virtual HRESULT SetVisuModes( const CATSamVisuMode iDefaultMode,
const CATSamVisuMode iGlobalMode,
const CATBoolean iPropagated= FALSE,
const CATBoolean iUpdateVisu= TRUE) = 0
Sets the default and global context visualization mode.
Parameters:
iDefaultMode
the default visualization mode.
iGlobalMode
the global visualization mode.
iPropagated
TRUE if modes are valuated due to propagation mechanism
iUpdatVisu
TRUE if Entities visulaization must be refreshed

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

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