KnowledgeExpert Methods

KWECheck.AddNewTuple()

Lets you add tuple under a check.

Signature

KWECheck.AddNewTuple(Validity : Boolean [, Object : Feature, ..]) : KWETuple

Arguments


Name	Input / Output	Required?	Type	Comment
`Validity`	In	Yes	Boolean	True (succeeded) or False (failed).
`Object`	In	No	Feature	Object to insert: objects separated by a comma.

ReturnType

KWETuple

KWECheck.AddSubTupleFailed()

Lets you create a report hierarchy of the "failed" sub-tuples in the tree.

Signature

KWECheck.AddSubTupleFailed([Feature : Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Feature`	In	No	Feature	Object seen as "failed"

ReturnType

Boolean

Example

The example below is based on a product containing two representations containing holes. A rule base is located under the product. It contains a check.

Variable : P :VPMRepInstance
Body :
Let L(List)
Let H (Hole)
L = P.Query(“Hole”,””)
If (L.Size() >=1)
	ThisCheck.AddTupleFailed(P)
For H inside L
	ThisCheck.AddSubTupleFailed(H)

KWECheck.AddSubTupleFailedWithWeight()

KWECheck.AddSubTupleFailedWithWeight() -

Signature

KWECheck.AddSubTupleFailedWithWeight(Severity : Integer [, Feature : Feature, ..]) : Boolean

Arguments


Name	Input/Output	Required?	Type	Comment
`Severity`	In	Yes	Integer	-
`Feature`	In	No	Feature	-

ReturnType

Boolean

KWECheck.AddSubTupleSucceeded()

Lets you create a report hierarchy of the "succeeded" sub-tuples in the tree.

Signature

KWECheck.AddSubTupleSucceeded([Feature : Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Feature`	In	No	Feature	Object seen as "succeeded"

ReturnType

Boolean

Example

The example below is based on a product containing two representations and holes. A rule base is located under the product. It contains a check.

Variable : P :VPMRepInstance
Body :
Let L(List)
Let H (Hole)
L = P.Query(“Hole”,””)
If (L.Size() >=1)
	ThisCheck.AddTupleSucceeded(P)
For H inside L
	ThisCheck.AddSubTupleSucceeded(H)

KWECheck.AddTupleFailed()

Lets you fill in the list used to generate the report of failed checks.

Signature

KWECheck.AddTupleFailed([Feature: Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Feature`	In	No	Feature	-

ReturnType

Boolean

Example

Variables : H:Hole;P:Part
					Body : if (H.Diameter > 5mm)
					ThisCheck > AddTupleFailed(H,P)

Note: Note that the tuple H,P is added to the report. Each call to this method adds a line to the report.

KWECheck.AddTupleFailedWithComment()

Lets you fill in the list used to generate the report of failed checks with a comment.

Signature

KWECheck.AddTupleFailedWithComment(Comment: Literal [, Feature: Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Comment`	In	Yes	Literal	Comment added to failed tuples
`Feature`	In	No	Feature	Failed tuples (variable argument )

ReturnType

Boolean

Example

H:Hole;P:Part
					ThisCheck->AddTupleFailedWithComment(Hole and Pad are failed,H,P)

KWECheck.AddTupleFailedWithName()

Lets you fill in the list used to generate the report of failed checks with a comment and a name. You can change the tuple name.

Signature

KWECheck.AddTupleFailedWithName(Name: Literal, Comment: Literal [, Feature: Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Name`	In	Yes	Literal	Name displayed in the immersive report.
`Comment`	In	Yes	Literal	Comment added to failed tuples.
`Feature`	In	No	Feature	Failed tuples (variable argument ).

ReturnType

Boolean

Example

H:Hole;P:Part
					ThisCheck->AddTupleFailedWithName(Tuple Failed,Hole and Pad 
					is failed,H,P)

KWECheck.AddTupleFailedWithWeight()

KWECheck.AddTupleFailedWithWeight() -

Signature

KWECheck.AddTupleFailedWithWeight(Severity : Integer [, Feature : Feature, ..]) : Boolean

Arguments


Name	Input/Output	Required?	Type	Comment
`Severity`	In	Yes	Integer	-
`Feature`	In	No	Feature	-

ReturnType

Boolean

KWECheck.AddTupleSucceeded()

Lets you fill in the list used to generate the report of succeeded checks.

Signature

KWECheck.AddTupleSucceeded([Feature: Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Feature`	In	No	Feature	-

ReturnType

Boolean

KWECheck.AddTupleSucceededWithComment()

Lets you fill in the list used to generate the report of succeeded checks with a comment.

Signature

KWECheck.AddTupleSucceededWithComment(Comment: Literal [, Feature: Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Comment`	In	Yes	Literal	Comment added to succeeded tuples.
`Feature`	In	No	Feature	Succeeded tuples (variable argument ).

ReturnType

Boolean

Example

H:Hole;P:Part
					ThisCheck->AddTupleSucceededWithComment(Hole and Pad is failed,H,P)

KWECheck.AddTupleSucceededWithName()

Lets you fill the list used to generate the report of succeeded checks with a comment and a name. You can change the tuple name.

Signature

KWECheck.AddTupleSucceededWithName(Name: Literal, Comment: Literal [, Feature: Feature, ..]) : Boolean

Arguments


Name	Input / Output	Required?	Type	Comment
`Name`	In	Yes	Literal	Name displayed in the immersive report.
`Comment`	In	Yes	Literal	Comment added to succeeded tuples.
`Feature`	In	No	Feature	Succeeded tuples (variable argument ).

ReturnType

Boolean

Example

H:Hole;P:Part
					ThisCheck->AddTupleSucceededWithName(Tuple Succeeded,Hole 
					and Pad is succeeded,H,P)

KWECheck.GetTuples()

KWECheck.GetTuples() -

Signature

KWECheck.GetTuples(Validity : Boolean) : List

Arguments


Name	Input/Output	Required?	Type	Comment
`Validity`	In	Yes	Boolean	-

ReturnType

List

KWEGenericRuleBaseComponent.GetRB()

Signature

KWEGenericRuleBaseComponent.GetRB() : KWERuleBase

ReturnType

KWERuleBase

KWEGenericRuleBaseComponent.GetRuleBase()

Signature

KWEGenericRuleBaseComponent.GetRuleBase() : KWERuleBase

ReturnType

KWERuleBase

KWERuleBase.GetRootsOfFacts()

Returns the list of the roots used to compute the facts.

Signature

KWERuleBase.GetRootsOfFacts() : List

ReturnType

List

KWECheck.GetTuples()

Lets you retrieve tuples under a check.

Signature

KWECheck.GetTuples(Validity : Boolean) : List

Arguments


Name	Input / Output	Required?	Type	Comment
`Validity`	In	Yes	Boolean	True (succeded) or False (failed).

ReturnType

List

KWETuple.AddNewTuple()

Lets you add a subtuple under a tuple.

Signature

KWETuple.AddNewTuple(Validity : Boolean [, Object : Feature, ..]) : KWETuple

Arguments


Name	Input / Output	Required?	Type	Comment
`Validity`	In	Yes	Boolean	True (succeeded) and False (failed).
`Object`	In	No	Feature	Objects to insert (separated by a comma).

ReturnType

KWETuple

KWETuple.GetTuples()

KWETuple.GetTuples() -

Signature

KWETuple.GetTuples(Validity : Boolean) : List

Arguments


Name	Input/Output	Required?	Type	Comment
`Validity`	In	Yes	Boolean	-

ReturnType

List