All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface CATICkeSetOfEquationsFactory

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

interface CATICkeSetOfEquationsFactory

Interface dedicated to the creation of Set of Equation features.

This interface is multi implemented on feature container and volatile factory returned by .
This interface requires the Knowledge Advisor license (KWA).

Method Index

o CreateSetOfEquations(CATUnicodeString&,CATUnicodeString&,CATCkeListOfParm,CATUnicodeString&,CATIParmPublisher_var&,CATCke::Boolean&,CATCke::Boolean&): Creates a set of equations relation between parameters (example : x+y=z and x*2=y).

Methods

o CreateSetOfEquations

public virtual CreateSetOfEquations(	const	`iSetOfEquationsName`,
	const	`iComment`,
	const	`iListOfParameters`,
	const	`iBody`,
	const	`ispRoot`	`= NULL_var`,
	const	`iRealnames`	`= 1`,
	const	`iImmediateSolving`	`= 1` )

Creates a set of equations relation between parameters (example : x+y=z and x*2=y). If a syntax error occurs, NULL_var is returned and a CATCkeParseException exception is raised

Parameters:

iSetOfEquationsName: = set of equations relation' name
iComment: = comment
iListOfParameters: = (pointer on list of CATBaseUnknown_var) contains literal used in inputs or outputs (x, y and z in our example)
iBody: = contains the string describing the set of equations ("x+y=z and x*2=y" in our example)
ispRoot: = (CATIParmPublisher) used to name parameters with RelativeName (root) method and so to be able to recognize parameters by their name Not used in realnames = false mode
iRealnames: = 2 possibilities to name a parameter in the body. CATCke::True names used are the one returned by RelativeName (root) and we try to recognize names used in the body with parameters of iListParameters.. CATCke::False names used are a1,a2,a3,etc...
a1 meaning the first parameter of iListParameters, a2, the second one, etc....
We advise you strongly to use this second method in your application to avoid NLS problems .
iImmediateSolving: TRUE if we want to perform a solving immediately

Returns:

= Set of equations created or NULL_var if syntax error. When creating a set of equation relation feature, it is highly recommended to aggregate it to another one. By default, the parameters that are passed as arguments MUST be in the same feature container. Other data models are not guarranted. We will enforce this behavior in future releases.

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