All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface CATIKweModelServices

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

interface CATIKweModelServices

Interface providing a set of services of the Knowledge Modeler.

Role: This interface is mono implemented. It is obtained from CATCkeGlobalFunctions::GetModelServices() method.

Method Index

o AddToCurrentSet(CATIKweModelServices::SetType,CATIParmPublisher_var&,CATBaseUnknown_var&): Adds an object to the current set.
o FindParm(CATIParmPublisher_var&,CATUnicodeString&,CATCke::Boolean): Tries to find a parameter by its name.
o GetCurrentSet(CATIKweModelServices::SetType,CATIParmPublisher_var&,int): Get the current set : ParameterSet,RelationSet,OptimizationSet,RuleBaseSet.
o GetCurrentSetWithRepRef(CATIKweModelServices::SetType,CATIParmPublisher_var&,int,void*): Get the current set : ParameterSet,RelationSet,OptimizationSet,RuleBaseSet.
o GetKnowledgeContainer(CATBaseUnknown_var&,int): Returns the Knowledge container where you will create parameters for example.
o VisibleParms(CATIParmPublisher_var&,CATCkeListOf(Parm)&,CATCke::Boolean,int): Retrieves the list of visible literals from a CATIParmPublisher.
o VisibleRelations(CATIParmPublisher_var,CATCkeListOf(Relation)&,CATCke::Boolean): Retrieves the list of visible relations from a CATIParmPublisher.

o SetType: Type of Set.

Methods

o AddToCurrentSet

public virtual AddToCurrentSet(	const	`iSetType`,
	const	`iRoot`,
	const	`iObjectToAdd`)

Adds an object to the current set.
It is not a recommended method. Please use GetCurrentSet instead.

Parameters:

iSetType: kind of set of object
iRoot: root object
iObjectToAdd: object to add

o FindParm

public virtual FindParm(	const	`iRoot`,
	const	`iParameterName`,
	const	`iRecursive`	`= 1`)

Tries to find a parameter by its name.

Parameters:

iRoot: : root object
iParameterName: : name of the parameter.
iRecursive: : indicates if we only scan the direct children or all the children

Returns:

the parameter found

o GetCurrentSet

public virtual GetCurrentSet(	const	`iSetType`,
	const	`iRoot`,
	const	`iForceCreation`	`= 0`)

Parameters:

iSetType: to choose the type of set (Parameter, relation, optimization or rulebase).
iRoot: The root object is where the set will be appended.
iForceCreation: to force the creation of set if it doesn't exist.

Returns:

ParameterSet,RelationSet,OptimizationSet,RuleBaseSet returned depending on the iSetType.
All those objects are in fact CATIParmPublisher_var.

o GetCurrentSetWithRepRef

public virtual GetCurrentSetWithRepRef(	const	`iSetType`,
	const	`iRoot`,
	const	`iForceSetCreation`,
		`pBag`)

Get the current set : ParameterSet,RelationSet,OptimizationSet,RuleBaseSet.
It is dedicated to applications which create parameters,relations,optimizations or rulebase and want to see them in the parameter set, relation set, optimization set and rulebase set (in the tree view).
If the Set does not exist and iRoot is a representation reference, it is created if argument iForceCreation is true.
If the Set does not exist and iRoot is a reference with a current engineering specification, it is created if argument iForceCreation is true.
If the Set does not exist and iRoot is a reference without a current engineering specification, a Knowledge engineering representation and the set are created if argument iForceCreation is true. The representation is added to bag.

Parameters:

iSetType: to choose the type of set (Parameter, relation, optimization or rulebase).
iRoot: The root object is where the set will be appended.
iForceCreation: to force the creation of set if it doesn't exist.
pBag: a pointer to an existing CATOmbLifeCycleRootsBag.

Returns:

ParameterSet,RelationSet,OptimizationSet,RuleBaseSet returned depending on the iSetType.
All those objects are in fact CATIParmPublisher_var.

o GetKnowledgeContainer

public virtual GetKnowledgeContainer(	const	`iRoot`,
	const	`iForceCreation`)

Returns the Knowledge container where you will create parameters for example.
It is not a recommended method. Please use GetCurrentSet instead.

Parameters:

iRoot: root object
iForceCreation: to force the creation of the Knowledge container.

Returns:

Knowledge container

o VisibleParms

public virtual VisibleParms(	const	`iRoot`,
		`iListToBeFilled`,
	const	`iRecursive`	`= 1`,
		`withFeatures`	`= 0`)

Retrieves the list of visible literals from a CATIParmPublisher. uses VisitChildren on CATIParmPublisher and filters the NotSeen literals

Parameters:

iRoot: root object
iListToBeFilled:: literals are added to this list already allocated
iRecursive: indicates if we only scan the direct children or all the children
withFeatures: indicates if we scan the CATICkeFeature or not

o VisibleRelations

public virtual VisibleRelations(	const	`iRoot`,
		`iListToBeFilled`,
	const	`iRecursive`	`= 1`)

Retrieves the list of visible relations from a CATIParmPublisher. uses VisitChildren on CATIParmPublisher and filters the non expressional relation

Parameters:

iRoot: root object
iListToBeFilled: relations are added to this list already allocated
iRecursive: indicates if we only scan the direct children or all the children

Enumerated Types

o SetType

enum SetType {
  Parameter,
  Relation,
  Optimization,
  RuleBase,
  Macro,
  LinkedRuleBase,
  ExternalParameter
}

Type of Set.

Parameters:

Parameter: This set contains parameters.
Relation: This set contains Relations.
Optimization: This set contains optimizations.
RuleBase: This set contains Rulebases.

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

KnowledgeInterfaces Interface CATIKweModelServices

Method Index

Enumerated Type Index

Methods

Enumerated Types