Retrascope

Sergey Smolov wrote:

1. The method with signature "Collection<VariableDeclaration> getDeclarations()" is already implemented. Is it really important to add another one with "Set<VariableDeclaration> getDeclarations()" signature?

2. As it is proposed to implement methods like "containsInput\Output" maybe we change other method names to "getInputs" and "getInput" for shortening?

3. Another renaming is proposed for making methods names shorter: InnerVariable -> Register.

4. Shall get-methods of the last group return null, if there is no variable with the specified name in this container?

1. A return type isn't part of a signature, so I think it would be better to replace Collection by Set to emphasise uniqueness of collection elements. But it is not essential.

2. OK.

3. OK.

4. Yes.

I propose to split the getDeclaration methods to getDataType, getInitialValue and getInvariantCondition methods and do not return VariableDeclaration explicitly.

I don't catch the idea.

The task was to implement the following methods:

1) multiple-get-methods:

public Set<VariableDeclaration> getDeclarations()
public Set<VariableDeclaration> getInputDeclarations()
public Set<VariableDeclaration> getOutputDeclarations()
public Set<VariableDeclaration> getInnerVariableDeclarations()

2) contains-methods:

public boolean containsVariable(String variableName)
public boolean containsInput(String variableName)
public boolean containsOutput(String variableName)
public boolean containsInnerVariable(String variableName)

3) single-get-methods:

public VariableDeclaration getDeclaration(String variableName)
public VariableDeclaration getInputDeclaration(String variableName)
public VariableDeclaration getOutputDeclaration(String variableName)
public VariableDeclaration getInnerVariableDeclaration(String variableName).

Suppose that VariableContainer keeps information in the Map<NodeVariable, VariableDeclaration> object, where VariableDeclaration keeps only invariant and initial value of the key NodeVariable.

How should change the proposed methods (multiple-get, single-get)?

Oh, I forget about the first group. For my classes these accessor methods are preferred:

1)

public Set<String> getVariables() //or getVariableNames and so on for other methods of this group
public Set<String> getInputs()
public Set<String> getOutputs()
public Set<String> getRegisters()

2) The second group is OK.

3) And now I think the third group may have no division based on variable types:

public DataType getDataType(String variableName)
public Node getInitialValue(String variableName)
public Node getInvariantCondition(String variableName)

And may be it is worth using maps of the form Map<String, VariableDeclaration> inside VariableContainer where VariableDeclaration contains DataType and two Nodes (initial value and invariant).

Having such structure as "String -> <DataType, Node, Node>" the task to identify which declaration is for input signal, becomes impossible. We need to store the NodeVariable object somehow because it contains VariableData descriptor in it's userdata field.