All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Class CATCkeLawAdapter

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

Usage: you can derive this class.


public class CATCkeLawAdapter

Class to be used as an adapter for objects that want to implement CATICkeLaw and CATICkeFunction interface.
First of all, it is an adapter of CATICkeLaw interface. This interface is used to create a formal expression that can be reused in geometrical operators such as parallel curves or in Knowledge relations It is also an adapter of CATICkeFunction. This interface defines functions that can be used in Knowledge language. In addition to extension, you must create the TIE object with - TIEchain_CATICkeLaw - TIEchain_CATICkeFunction

See also:
CATICkeLaw, CATICkeFunction


Constructor and Destructor Index


o CATCkeLawAdapter()
o ~CATCkeLawAdapter()

Method Index


o AddFormalParameter(CATICkeParm_var&)
Adds a formal parameter to the law.
o ComputesCompositeLaw()
Computes a CATCompositeLaw.
o GetDescription()
Returns the description of this function.
o GetDomain(double&,double&)
Returns the domain of validity of the law.
o GetFormalParameters()
Returns the list of the formal parameters.
o GetFunction()
Returns the function attributed to the Law.
o IsRunnable()
Indicates if this function can be evaluated.
o RemoveFormalParameter(CATICkeParm_var&)
Removes a formal parameter to the law.
o Run(CATCkeListOfParm,CATICkeParm_var&,CATCkeEvalContext*)
Evaluates the function on a list of parameters.

Constructor and Destructor


o CATCkeLawAdapter
public CATCkeLawAdapter()
o ~CATCkeLawAdapter
public virtual ~CATCkeLawAdapter()

Methods


o AddFormalParameter
public virtual void AddFormalParameter( const CATICkeParm_var& iParm) const
Adds a formal parameter to the law.
Parameters:
iParm
The parameter to be added to the law.
o ComputesCompositeLaw
public virtual CATCompositeLaw* ComputesCompositeLaw()const
Computes a CATCompositeLaw.
Returns:
The CATCompositeLaw.
o GetDescription
public virtual CATICkeSignature_var GetDescription()const
Returns the description of this function.
Returns:
The signature of the function.
o GetDomain
public virtual void GetDomain(double& oMin,
double& oMax) const
Returns the domain of validity of the law.
Parameters:
oMin
Minimum limit of the domain
oMax
Maximum limit of the domain
o GetFormalParameters
public virtual CATCkeListOfParm GetFormalParameters()const
Returns the list of the formal parameters.
Returns:
The list of parameters of the law.
o GetFunction
public virtual CATICkeFunction_var GetFunction()const
Returns the function attributed to the Law.
Returns:
The function.
o IsRunnable
public virtual CATCke::Boolean IsRunnable()const
Indicates if this function can be evaluated.
Returns:
true : the function is runnable, false : the function is not runnable
o RemoveFormalParameter
public virtual void RemoveFormalParameter( const CATICkeParm_var& iParm) const
Removes a formal parameter to the law.
Parameters:
iParm
Removes the specified formal parameter.
o Run
public virtual void Run(CATCkeListOfParm iListOfParameters,
const CATICkeParm_var& iReturnedParameter,
const CATCkeEvalContext* iEvaluationContext=NULL) const
Evaluates the function on a list of parameters.
Parameters:
iListOfParameters
List of parameters in argument of the function.
Those arguments can be in input or in output of the function.
(Note that CATCkeListOfParm is a CATLISTV(CATBaseUnknown_var)* )
iReturnedParameter
parameter returned by the function.
iEvaluationContext
context of evaluation.

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

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