All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Interface CATICkeRelationFactory

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

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


interface CATICkeRelationFactory

Interface dedicated to parameter sets creation.
Role: manages the creation of parameter sets.

See also:
CATIParmPublisher
See also:
CATIParmManipulator


Method Index


o Copy(CATICkeRelation_var&)
Creates a relation from another by copying it.
o CreateAction(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATICkeSignature_var&,CATCkeListOfParm,CATUnicodeString&,CATIParmPublisher_var&,CATCke::Boolean&)
Do not use.
o CreateConstraint(CATUnicodeString,CATUnicodeString,CATUnicodeString,CATUnicodeString)
o CreateDesignTable(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,int,int)
Creates a fully functional design table (with its embedded sheet) from a file (excel or text file).
o CreateFunctionalExpression(CATUnicodeString,CATUnicodeString,CATUnicodeString,CATUnicodeString)
o CreateKweMacro(CATUnicodeString&,CATUnicodeString&)
Creates a feature macro with arguments.
o CreateParameterSet(CATUnicodeString)
Creates a parameter set.
o CreateProgram(CATUnicodeString,CATUnicodeString,CATUnicodeString,CATUnicodeString)
o CreateReaction()
Creates a feature reaction.
o CreateRelationSet(CATUnicodeString)
Creates a relation set.
o CreateSheet(CATUnicodeString&,int)
Create a design table sheet.

Methods


o Copy
public virtual CATICkeRelation_var Copy( const CATICkeRelation_var& iRelationToCopy) = 0
Creates a relation from another by copying it. Works only on formulas, not on rules or checks. Note that second relation will reference the same parameters, il will be deactivated
Parameters:
iRelationToCopy
parameter to copy
Returns:
CATICkeRelation_var relation copied
o CreateAction
public virtual CATICkeRelation_var CreateAction( const CATUnicodeString& iRelationName,
const CATUnicodeString& iComment,
const CATUnicodeString& iFamily,
const CATICkeSignature_var& iSignature,
const CATCkeListOfParm iListOfParameters,
const CATUnicodeString& iBody,
const CATIParmPublisher_var& iRoot= NULL_var,
const CATCke::Boolean& iRealnames= 1) = 0
Do not use.
o CreateConstraint
public virtual CATICkeExpression_var CreateConstraint(CATUnicodeString name,
CATUnicodeString comment,
CATUnicodeString formalSignature,
CATUnicodeString body) =0
Deprecated:
V5R16 CATICkeExpressionFactory#CreateConstraint
Creates a check expression.
Parameters:
name
name of the expression
comment
comment of the expression
formalSignature
This string describes the type of used parameters and the returned type of the expression.
For a check, no value is returned
body
the body of the check expression
o CreateDesignTable
public virtual CATIDesignTable_var CreateDesignTable( const CATUnicodeString& iRelationName,
const CATUnicodeString& iComment,
const CATUnicodeString& iFilePath,
int orientation= 1,
int sheetWithoutFile= 0) = 0
Creates a fully functional design table (with its embedded sheet) from a file (excel or text file).
Parameters:
iRelationName
The name of the design table
iComment
The comment associated to the design table
iFilePath
The path of the sheet file. - If param sheetWithoutFile = 0 : if this path contains ".xls", the Excel format is assumed, else the tabulated text format is used. If this path is empty, no sheet is aggregated to the design table, and the user has to create a sheet (method CreateSheet) and associate it to an excel or text file) - If param sheetWithoutFile = 1 : no matter with the content of this path
orientation
1 if vertical, 0 else (used only if path != "" and sheetWithoutFile = 0)
sheetWithoutFile
If sheetWithoutFile = 1, a model sheet is created (sheet with persitent memory storage, but no file) and it won't be possible to associate a file to this sheet.
o CreateFunctionalExpression
public virtual CATICkeExpression_var CreateFunctionalExpression(CATUnicodeString name,
CATUnicodeString comment,
CATUnicodeString formalSignature,
CATUnicodeString body) = 0
Deprecated:
V5R16 CATICkeExpressionFactory#CreateFunctionalExpression
Creates a functional expression (to be used in a knowledgeware formula).
Parameters:
name
name of the expression
comment
comment of the expression
formalSignature
This string describes the type of used parameters and the returned type of the expression.
For a formula, the returned value is the type of the output parameter of the formula
body
the body of the functional expression
o CreateKweMacro
public virtual CATICkeFunction_var CreateKweMacro( const CATUnicodeString& iArgumentString,
const CATUnicodeString& iScriptText) = 0
Creates a feature macro with arguments.
It is initialized with the given arguments
Parameters:
iArgumentString
the argument string
iScriptText
the script text
Returns:
The feature macro
Example:
CATICkeFunction_var MyFunc = MyFact->CreateKweMacro("MyArg","MyArg.Value = 10.0\nEnd Sub");
o CreateParameterSet
public virtual CATIParmPublisher_var CreateParameterSet( const CATUnicodeString name) =0
Creates a parameter set.
Parameters:
name
name of the parameter set.
Returns:
the newly created relation set viewed a a parameter publisher.
o CreateProgram
public virtual CATICkeExpression_var CreateProgram(CATUnicodeString name,
CATUnicodeString comment,
CATUnicodeString formalSignature,
CATUnicodeString body) = 0
Deprecated:
V5R16 CATICkeExpressionFactory#CreateProgram
Creates a rule expression.
Parameters:
name
name of the expression
comment
comment of the expression
formalSignature
This string describes the type of used parameters and the returned type of the expression.
For a rule, no value is returned
body
the body of the rule expression
o CreateReaction
public virtual CATISpecObject_var CreateReaction()= 0
Creates a feature reaction.
o CreateRelationSet
public virtual CATIParmPublisher_var CreateRelationSet( const CATUnicodeString name) =0
Creates a relation set.
Parameters:
name
name of the relation set.
Returns:
the newly created relation set viewed a a parameter publisher.
o CreateSheet
public virtual CATICkeSheet_var CreateSheet( const CATUnicodeString& iFilePath,
int iType= 0) = 0
Create a design table sheet.
Parameters:
iFilePath
The path of the source file. It can be an Excel or a Lotus sheet or a tabulated text file, or an empty path (if iType != 4, you'll have to call CreateSourceFile on CATICkeSheet interface). If the path isn't empty and the file doesn't exist, the file is created.
iType
- if iType = 4, whatever the content of the path, a model sheet is created (sheet with persitent memory storage, but no file) - if path is empty, uses the type to know what kind of sheet has to be created
Legal values: the test can be either 1 Excel one. 2 Text one 3 Lotus one 4 Model one
Returns:
the created sheet. It returns NULL_var if the file creation failed (in the case where the file has to be created) or if Excel or Lotus is asked on UNIX

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

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