All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface CATICkeParmFactory

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

interface CATICkeParmFactory

Interface dedicated to parameters factory.
Role: This interface helps you to create parameters.
WATCH OUT :
Dont forget to Initialise Literals environnement on the
Literals.feat catalog before any kind of work with parameters
This interface is implemented on any Feature containers: thus it creates persistant parameters.
It is also implemented on a volatile static object (CATCKEVolatileFactory): thus it creates volatile parameters.

Usage :
//////////////////////////////////////////////////////////////////////////

#include "CATCke.h"
#include "CATICkeUnit.h"
#include "CATICkeMKSUnit.h"
#include "CATICkeMagnitude.h"
#include "CATICkeParmFactory.h"
#include "CATICkeParm.h"
//------------------------------------------------
// Get this factory from your feat container
// to create features (persistent)
//------------------------------------------------
CATICkeParmFactory_var fact = cont;

//------------------------------------------------
// Or use the Volatile factory
//------------------------------------------------
CATICkeParmFactory_var fact = CATCKEVolatileFactory;

//------------------------------------------------
// you can create parameters
//------------------------------------------------
CATICkeParm_var p1 = fact->CreateLength ("L",3.3);

See also:: , , , ,

Method Index

o Copy(CATICkeParm_var&,CATCke::Boolean&): Creates a literal from another by copying its value.
o CreateAngle(CATUnicodeString&,double): Creates angle parameter.
o CreateBoolean(CATUnicodeString&,CATCke::Boolean): Creates boolean parameter.
o CreateDate(CATUnicodeString&,CATTime&): Creates a date parameter.
o CreateDimension(CATICkeMagnitude_var&,CATUnicodeString&,double): Creates dimension parameter.
o CreateDimension(CATICkeMagnitude_var&,CATUnicodeString&,CATICkeInst_var&): Creates dimension parameter.
o CreateEnumere(CATIEnumere_var&,CATUnicodeString&,int): Creates an enumerated parameter from rank name (1 to n).
o CreateEnumere(CATIEnumere_var&,CATUnicodeString&,CATUnicodeString&): Creates an enumerated parameter from value.
o CreateInteger(CATUnicodeString&,int): Creates integer parameter.
o CreateLength(CATUnicodeString&,double): Creates length parameter.
o CreateList(CATUnicodeString&): Creates a List object.
o CreateLiteral(CATICkeType_var&,CATUnicodeString&): Creates a literal from its type.
o CreateMKSUnit(): Creates a MKS Unit equivalent to a scalar.
o CreateMKSUnit(CATICkeMKSUnit::Basic,int): Creates a MKS Unit equivalent to a primitive magnitude.
o CreateMKSUnit(int,int,int,int,int,int,int,int,int,int): Creates a MKS Unit equivalent to a combination of primitive magnitude.
o CreateMass(CATUnicodeString&,double): Do not use it.
o CreateObjectReference(CATBaseUnknown_var&): Creates object reference.
o CreateObjectReference(CATICkeType_var&,CATUnicodeString&): Creates an empty object reference of a given type.
o CreateParmManipulator(): Creates a parm manipulator.
o CreateReal(CATUnicodeString&,double): Creates real parameter.
o CreateString(CATUnicodeString&,CATUnicodeString&): Creates string parameter.
o CreateTime(CATUnicodeString&,double): Do not use it.
o InitAndWakeUp(): Initialise Literals Catalog and wakes up all relations.
o InitStartUps(): Initialise LiteralFeatures environnement.

Methods

o Copy

public virtual Copy(	const	`iParameterToCopy`,
	const	`iWithFormula`	`= 0`)

Creates a literal from another by copying its value. Note that at the end, the parameter is not aggregated. One option is to copy the existing formula that valuates the literal if any,
The formula is also not aggregated. It will reference the same input parameters as the original formula.

Parameters:

iParameterToCopy: parameter to copy
iWithFormula: indicates if we wish to copy the formula (note that the formula copied won't be agregated to anything).
Legal values: 0 No copy of the formula. 1 Copy of the formula.

Returns:

literal copied

o CreateAngle

public virtual CreateAngle(	const	`iParameterName`,
	const	`iParameterValue`)

Creates angle parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value in MKS !!! (i.e. radian) In case of a persistent object, this parameter must be aggregated.

Returns:

parameter created

o CreateBoolean

public virtual CreateBoolean(	const	`iParameterName`,
	const	`iParameterValue`)

Creates boolean parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value In case of a persistent object, this parameter must be aggregated.

Returns:

parameter created

o CreateDate

public virtual CreateDate(	const	`iParameterName`,
	const	`iParameterValue`)

Creates a date parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value in MKS !!! (i.e. radian) In case of a persistent object, this parameter must be aggregated.

Returns:

parameter created

o CreateDimension

public virtual CreateDimension(	const	`iMagnitude`,
	const	`iParameterName`,
	const	`iParameterValue`)

Creates dimension parameter.

Parameters:

iMagnitude: parameters type
iParameterName: parameter name (never changed)
iParameterValue: parameter value in MKS !!!

Returns:

parameter created

o CreateDimension

public virtual CreateDimension(	const	`iMagnitude`,
	const	`iParameterName`,
	const	`iParameterValue`)

Creates dimension parameter.

Parameters:

iMagnitude: parameters type
iParameterName: parameter name (never changed)
iParameterValue: parameter value

Returns:

parameter created

o CreateEnumere

public virtual CreateEnumere(	const	`iEnumereType`,
	const	`iParameterName`,
	const	`iParameterRank`)

Creates an enumerated parameter from rank name (1 to n).

Parameters:

iEnumereType: enumerated type
iParameterName: parameter name
iParameterRank: parameter rank (from 1 to n)

Returns:

parameter created

o CreateEnumere

public virtual CreateEnumere(	const	`iEnumereType`,
	const	`iParameterName`,
	const	`iParameterValue`)

Creates an enumerated parameter from value.

Parameters:

iEnumereType: enumerated type
iParameterName: parameter name
iParameterValue: parameter value

Returns:

parameter created

o CreateInteger

public virtual CreateInteger(	const	`iParameterName`,
	const	`iParameterValue`)

Creates integer parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value In case of a persistent object, this parameter must be aggregated.

Returns:

parameter created

o CreateLength

public virtual CreateLength(	const	`iParameterName`,
	const	`iParameterValue`)

Creates length parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value in MKS !!! (i.e. meters) In case of a persistent object, this parameter must be aggregated.

Returns:

parameter created

o CreateList

public virtual CreateList( const iName)

Creates a List object.

Parameters:

iName: name of the list. The object must be aggregated.

Returns:

list created

o CreateLiteral

public virtual CreateLiteral(	const	`iParameterType`,
	const	`iParameterName`)

Creates a literal from its type.

Parameters:

iParameterType: parameter type
iParameterName: parameter name

Returns:

parameter created

o CreateMKSUnit

public virtual CreateMKSUnit(

)

Creates a MKS Unit equivalent to a scalar. This is a C++ object in any case.

Returns:: pMKS equivalent created

o CreateMKSUnit

public virtual CreateMKSUnit(	const	`iBasicMagnitude`,
	const	`iCoeff`)

Creates a MKS Unit equivalent to a primitive magnitude.
(example m2, s-1).

Parameters:

iBasicMagnitude: primitive magnitude
iCoeff: exponent

Returns:

CATICkeMKSUnit_var MKSUnit created This is a C++ object in any case.

o CreateMKSUnit

public virtual CreateMKSUnit(	const	`iMeterCoeff`,
	const	`iKilogramCoeff`,
	const	`iSecondCoeff`,
	const	`iAmperCoeff`,
	const	`iTemperatureCoeff`,
	const	`iCandelaCoeff`,
	const	`iMoleNumberCoeff`,
	const	`iPriceCoeff`,
	const	`iRadianCoeff`,
	const	`iSteradianCoeff`)

Creates a MKS Unit equivalent to a combination of primitive magnitude.
(example kgxs-2)

Parameters:

iMeterCoeff: exponent for length
iKilogramCoeff: exponent for mass
iSecondCoeff: exponent for time
iAmperCoeff: exponent for amper
iTemperatureCoeff: exponent for temperature
iCandelaCoeff: exponent for candela
iMoleNumberCoeff: exponent for mole number
iPriceCoeff: exponent for price
iRadianCoeff: exponent for radian
iSteradianCoeff: exponent for steradian This is a C++ object in any case.

Returns:

pMKS equivalent created

o CreateMass

public virtual CreateMass(	const	`iParameterName`,
	const	`iParameterValue`)

Do not use it. Use CreateDimension (CATParmDictionary::FindMagnitude("MASS")) instead Creates mass parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value in MKS !!! (i.e. gram)

Returns:

parameter created

o CreateObjectReference

public virtual CreateObjectReference( const iFeature)

Creates object reference.
An object reference is a way to see an object as a parameter in order to use it in Knowledge expressions or Knowledge relations,
Such an object reference can only be used in input of Knowledgeware relations or expressions.

Parameters:

iFeature: feature to be referenced : should implement
Returns:: CATICkeParm_var object reference created

o CreateObjectReference

public virtual CreateObjectReference(	const	`iType`,
	const	`iName`)

Creates an empty object reference of a given type.
We recommend not to use this method.

Parameters:

iType: type of the object reference
iName: name of the object reference

Returns:

parameter created

o CreateParmManipulator

public virtual CreateParmManipulator(

)

Creates a parm manipulator. This manipulator will not change the persistent parameters range. This method is used to build a manipulator that will block temporarily the user manipulations. In no case this manipulator will change the persistent bounds of the parameter. If you want to persistently change the bounds of the parameter refer to the CATICkeParm interface.
Use only on Volatile Factory.

Returns:: parameter manipulator created

o CreateReal

public virtual CreateReal(	const	`iParameterName`,
	const	`iParameterValue`)

Creates real parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value In case of a persistent object, this parameter must be aggregated.

Returns:

parameter created

o CreateString

public virtual CreateString(	const	`iParameterName`,
	const	`iParameterValue`)

Creates string parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value In case of a persistent object, this parameter must be aggregated.

Returns:

parameter created

o CreateTime

public virtual CreateTime(	const	`iParameterName`,
	const	`iParameterValue`)

Do not use it. Use CreateDimension (CATParmDictionary::FindMagnitude("TIME")) instead Creates time parameter.

Parameters:

iParameterName: parameter name (never changed)
iParameterValue: parameter value in MKS !!! (i.e. second)

Returns:

parameter created

o InitAndWakeUp

public virtual InitAndWakeUp(

)

Initialise Literals Catalog and wakes up all relations.
Should be done when creating a new container or loading it.
This method replaces InitStartups. It loads the Literals.feat catalog and does InitStartups on it.
This should be used on the feature container where relations have been stored.

o InitStartUps

public virtual InitStartUps(

)

Initialise LiteralFeatures environnement.
It finds all startups needed in this container.
This method should be used on Literals.feat catalog container only.

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