All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamDefineSolution

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

Usage: you can freely reimplement this interface.


interface CATISamDefineSolution

Specify Solution Sets parameters.
Role: In order to create a solution set, this interface allow to defined the required input sets that are usefull to define this solution. This interface is used by the CATSamCreateCaseCmd in order to define a command that create new analysis case associated to the solution type. For this, define an header as follow:

 static CATUnicodeString Solution("MyLateTypeSolution");
 new AniCommandHeader ( "CAAAniInsertCase" , "CATAnalysisModelerUI" , "CATSamCreateCaseCmd"  ,(void *) &Solution);

It allow also to define automatically if some sensors need to be created with the solution and to create them.

See also:
CATSamDefineSet


Method Index


o DefineDefaultSensors(CATBoolean,CATISamAnalysisSet*)
Returns if sensors need to be create or creates them.
o GetSetsForDefinition(int&,CATSamDefineSet*&)
Retreives the required input set to define a solution.

Methods


o DefineDefaultSensors
public virtual int DefineDefaultSensors( const CATBoolean iCreateSensor,
const CATISamAnalysisSet* iNewSolution) = 0
Returns if sensors need to be create or creates them.
Parameters:
iCreateSensor
behavior of the method
Legal values:
  • FALSE : Returns the number of sensors. No creation.
  • TRUE : Create the sensors.
iNewSolution
The created Solution
Returns:
Number of created sensors.
o GetSetsForDefinition
public virtual HRESULT GetSetsForDefinition(int& oNbDefineSets,
CATSamDefineSet*& oDefineSets) = 0
Retreives the required input set to define a solution.
Parameters:
oNbDefineSets
The size of the array oDefineSets.
oDefineSets
The array of input sets parameters.
Returns:
HRESULT if E_FAIL and an error is set up, the case will not be created by CATSamCreateCaseCmd commmand and an error window will be displayed.

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

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