com.example.sulemaia.Model

Class HeuristicPathTree.Node

java.lang.Object

com.example.sulemaia.Model.HeuristicPathTree.Node

Enclosing class:

HeuristicPathTree

public static class HeuristicPathTree.Node
extends Object

Class for the creation of a node related to any Heuristic Algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	accessible
private float	accumulative
private ArrayList<HeuristicPathTree.Node>	children
private float	cost
private HeuristicPathTree.Node	father
private String	name
private int	posX
private int	posY
private float	remaining
private StringBuilder	step

Constructor Summary

Constructors

Constructor and Description
Node(String name, float cost, boolean accessible, int y, int x) Constructor of the Heuristic Algorithm Node.

Method Summary

Modifier and Type	Method and Description
private void	addChild(HeuristicPathTree.Node child) Add a child to a specific father node.
float	getAccumulative() Get the accumulative value of the node.
ArrayList<HeuristicPathTree.Node>	getChildren() Get the children related to a certain node.
float	getCost() Get the current cost of a node.
HeuristicPathTree.Node	getFather() Get the father related to a certain node.
String	getName() Get the name of the node.
int	getPosX() Get the X coordinate from a node.
int	getPosY() Get the Y coordinate of the node.
float	getRemaining() Get the remaining value from the current node to the final node.
String	getStep() Get the current step of the algorithm.
boolean	isAccessible() Check if a node is accessible by the character.
boolean	isFinal(int y, int x) Check if the actual node is the final node.
void	setAccessible(boolean accessible) Method to set a node as accessible or not to the character.
void	setAccumulative(float accumulative) Method to get the accumulative value of the node.
void	setCost(float cost) Set the current cost to the node.
void	setFather(HeuristicPathTree.Node father) Set a father to a certain node.
void	setName(String name) Set the name to a node.
void	setPosX(int posX) Set the X coordinate to a node.
void	setPosY(int posY) Set y coordinate to a node.
void	setRemaining(float remaining) Set the remaining value from a certain node to the final node.
void	setStep(int step) Set the current step to the node.
void	setStep(StringBuilder step) Set the current step to the node.

Methods inherited from class java.lang.Object

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

Field Detail

children

private ArrayList<HeuristicPathTree.Node> children

father

private HeuristicPathTree.Node father

step

private StringBuilder step

name

private String name

cost

private float cost

posY

private int posY

posX

private int posX

accumulative

private float accumulative

remaining

private float remaining

accessible

private boolean accessible

Constructor Detail

Node

public Node(String name,
            float cost,
            boolean accessible,
            int y,
            int x)

Constructor of the Heuristic Algorithm Node.

Parameters:

name - Name of the node.

cost - Cost of the node.

accessible - Whether the node is accessible to the character or not.

y - Y coordinate.

x - X coordinate.

Method Detail

isAccessible

public boolean isAccessible()

Check if a node is accessible by the character.

Returns:

a boolean variable.

isFinal

public boolean isFinal(int y,
                       int x)

Check if the actual node is the final node. Deprecated.

Parameters:

y - Y coordinate.

x - X coordinate.

Returns:

a boolean variable.

setAccessible

public void setAccessible(boolean accessible)

Method to set a node as accessible or not to the character. Deprecated

Parameters:

accessible - boolean variable.

setStep

public void setStep(StringBuilder step)

Set the current step to the node. Deprecated.

Parameters:

step - Step number.

getPosY

public int getPosY()

Get the Y coordinate of the node.

Returns:

a position.

setPosY

public void setPosY(int posY)

Set y coordinate to a node. Deprecated.

Parameters:

posY - Y coordinate.

getPosX

public int getPosX()

Get the X coordinate from a node.

Returns:

X coordinate.

setPosX

public void setPosX(int posX)

Set the X coordinate to a node. Deprecated.

Parameters:

posX - X coordinate.

getAccumulative

public float getAccumulative()

Get the accumulative value of the node. Criteria used for the Uniform Cost algorithm.

Returns:

Node weight at that moment.

setAccumulative

public void setAccumulative(float accumulative)

Method to get the accumulative value of the node. Criteria used for the Uniform Cost algorithm.

Parameters:

accumulative - accumulative value of the node.

getRemaining

public float getRemaining()

Get the remaining value from the current node to the final node.

Returns:

a remaining value.

setRemaining

public void setRemaining(float remaining)

Set the remaining value from a certain node to the final node.

Parameters:

remaining - remaining value.

getChildren

public ArrayList<HeuristicPathTree.Node> getChildren()

Get the children related to a certain node.

Returns:

an Arraylist containing the children list.

addChild

private void addChild(HeuristicPathTree.Node child)

Add a child to a specific father node.

Parameters:

child - Child node to be added to the father.

getFather

public HeuristicPathTree.Node getFather()

Get the father related to a certain node.

Returns:

the father node.

setFather

public void setFather(HeuristicPathTree.Node father)

Set a father to a certain node.

Parameters:

father - Father node.

getStep

public String getStep()

Get the current step of the algorithm.

Returns:

the step value.

setStep

public void setStep(int step)

Set the current step to the node.

Parameters:

step - current step.

getName

public String getName()

Get the name of the node.

Returns:

Name of the node.

setName

public void setName(String name)

Set the name to a node.

Parameters:

name - Node name.

getCost

public float getCost()

Get the current cost of a node.

Returns:

Cost value.

setCost

public void setCost(float cost)

Set the current cost to the node.

Parameters:

cost - Current cost.