edu.uiowa.cs.clc.kind2.lustre

Class ComponentBuilder

java.lang.Object

edu.uiowa.cs.clc.kind2.lustre.ComponentBuilder

public class ComponentBuilder
extends java.lang.Object

This class represents a builder for a function/node. Kind 2 supports the function and node keywords, which have slightly different semantics. Like the name suggests, the output(s) of a function should be a non-temporal combination of its inputs. That is, a function cannot use the ->, pre, merge, when, condact, or activate operators. A function is also not allowed to call a node, only other functions. In Lustre terms, functions are stateless.

In Kind 2, these restrictions extend to the contract attached to the function, if any. Note that besides the ones mentioned here, no additional restrictions are enforced on functions compared to nodes.

Constructor Summary

Constructors

Constructor and Description
ComponentBuilder(java.lang.String id) Constructor

Method Summary

Modifier and Type	Method and Description
void	addAssertion(Expr assertion) add an assertion
void	addEquation(IdExpr var, Expr expr) add an equation
void	addEquation(java.util.List<IdExpr> vars, Expr expr) add an equation
void	addProperty(Expr expr) add a property for Kind2 to check
void	addProperty(java.lang.String name, Expr expr) add a property for Kind2 to check
IdExpr	createConstInput(java.lang.String name, Type type) add a constant input parameter
IdExpr	createLocalConst(java.lang.String name, Expr expr) define a local constant
IdExpr	createLocalConst(java.lang.String name, Type type) define a local symbolic constant
IdExpr	createLocalConst(java.lang.String name, Type type, Expr expr) define a local constant
IdExpr	createLocalVar(java.lang.String name, Type type) declare a local variable
IdExpr	createVarInput(java.lang.String name, Type type) add a variable input parameter
IdExpr	createVarOutput(java.lang.String name, Type type) add a variable output parameter
void	setContractBody(ContractBodyBuilder contractBodyBuilder) set the contract body for the component

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentBuilder

public ComponentBuilder(java.lang.String id)

Constructor

Parameters:

id - name of the component

Method Detail

createConstInput

public IdExpr createConstInput(java.lang.String name,
                               Type type)

add a constant input parameter

Parameters:

name - name of the input parameter

type - type of the input parameter

Returns:

an id-expr for the input parameter

createVarInput

public IdExpr createVarInput(java.lang.String name,
                             Type type)

add a variable input parameter

Parameters:

name - name of the input parameter

type - type of the input parameter

Returns:

an id-expr for the input parameter

createVarOutput

public IdExpr createVarOutput(java.lang.String name,
                              Type type)

add a variable output parameter

Parameters:

name - name of the output parameter

type - type of the output parameter

Returns:

an id-expr for the output parameter

setContractBody

public void setContractBody(ContractBodyBuilder contractBodyBuilder)

set the contract body for the component

Parameters:

contractBodyBuilder - a builder for the contract body

createLocalConst

public IdExpr createLocalConst(java.lang.String name,
                               Type type)

define a local symbolic constant

Parameters:

name - name of the local constant

type - type of the local constant

Returns:

an id-expr for the local constant

createLocalConst

public IdExpr createLocalConst(java.lang.String name,
                               Expr expr)

define a local constant

Parameters:

name - name of the local constant

expr - definition of the local constant

Returns:

an id-expr for the local constant

createLocalConst

public IdExpr createLocalConst(java.lang.String name,
                               Type type,
                               Expr expr)

define a local constant

Parameters:

name - name of the local constant

type - type of the local constant

expr - definition of the local constant

Returns:

an id-expr for the local constant

createLocalVar

public IdExpr createLocalVar(java.lang.String name,
                             Type type)

declare a local variable

Parameters:

name - name of the local variable

type - type of the local variable

Returns:

an id-expr for the local variable

addEquation

public void addEquation(IdExpr var,
                        Expr expr)

add an equation

Parameters:

var - lhs of the equation

expr - rhs of the equation

addEquation

public void addEquation(java.util.List<IdExpr> vars,
                        Expr expr)

add an equation

Parameters:

vars - lhs of the equation

expr - rhs of the equation

addProperty

public void addProperty(java.lang.String name,
                        Expr expr)

add a property for Kind2 to check

Parameters:

name - name of the property

expr - the property to check

addProperty

public void addProperty(Expr expr)

add a property for Kind2 to check

Parameters:

expr - the property to check

addAssertion

public void addAssertion(Expr assertion)

add an assertion

Parameters:

assertion - the assertion to add