org.eclipse.eavp.viz.service.mesh.datastructures

Class BoundaryCondition

java.lang.Object

org.eclipse.eavp.viz.datastructures.VizObject.VizObject

org.eclipse.eavp.viz.service.mesh.datastructures.BoundaryCondition

All Implemented Interfaces:

IVizObject, IVizUpdateable

public class BoundaryCondition
extends VizObject

This class provides a boundary condition for edges.

Currently, a single edge can associate with at most two boundary conditions: one for each polygon it connects. This means that BoundaryConditions should be stored in Polygons rather than an Edge instance, which may be shared between two polygons.

Author:

Jordan H. Deyton, Anna Wojtowicz

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateable

iComponentListener

Constructor Summary

Constructors

Constructor and Description
BoundaryCondition() The nullary constructor.
BoundaryCondition(BoundaryConditionType type) Constructs a BoundaryCondition with the specified BoundaryConditionType.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() This operation returns a clone of the BoundaryCondition using a deep copy.
void	copy(BoundaryCondition condition) This operation copies the contents of a BoundaryCondition into the current object using a deep copy.
boolean	equals(java.lang.Object otherObject) This operation is used to check equality between this BoundaryCondition and another.
BoundaryConditionType	getType() Gets the type of the BoundaryCondition.
java.util.ArrayList<java.lang.Float>	getValues() Gets the parameter values for this BoundaryCondition.
int	hashCode() This operation returns the hash value of the BoundaryCondition.
void	setType(BoundaryConditionType type) Sets the type of the BoundaryCondition.
void	setValues(java.util.ArrayList<java.lang.Float> values) Sets the parameter values for the BoundaryCondition.
java.lang.String	toString() Convert the BoundaryCondition into a String representation, beginning with its type and having each value separated with a space

Methods inherited from class org.eclipse.eavp.viz.datastructures.VizObject.VizObject

copy, getDescription, getId, getName, register, setDescription, setId, setName, unregister, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BoundaryCondition

public BoundaryCondition()

The nullary constructor. Sets all values to their defaults (the type is None, and the values are all 0).

BoundaryCondition

public BoundaryCondition(BoundaryConditionType type)

Constructs a BoundaryCondition with the specified BoundaryConditionType. Every other feature of the BoundaryCondition is set to its default value.

Parameters:

type - The initial BoundaryConditionType.

Method Detail

getType

public BoundaryConditionType getType()

Gets the type of the BoundaryCondition.

Returns:

A BoundaryConditionType.

setType

public void setType(BoundaryConditionType type)

Sets the type of the BoundaryCondition.

Parameters:

type - The new BoundaryConditionType.

getValues

public java.util.ArrayList<java.lang.Float> getValues()

Gets the parameter values for this BoundaryCondition.

Returns:

An ArrayList of 5 floating point numbers.

setValues

public void setValues(java.util.ArrayList<java.lang.Float> values)

Sets the parameter values for the BoundaryCondition. The input must be an ArrayList of exactly 5 Floats.

Parameters:

values - The new parameter values for the BoundaryCondition.

toString

public java.lang.String toString()

Convert the BoundaryCondition into a String representation, beginning with its type and having each value separated with a space

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the BoundaryCondition.

hashCode

public int hashCode()

This operation returns the hash value of the BoundaryCondition.

Specified by:

hashCode in interface IVizObject

Overrides:

hashCode in class VizObject

Returns:

The hash of the Object.

See Also:

Identifiable#hashCode()

equals

public boolean equals(java.lang.Object otherObject)

This operation is used to check equality between this BoundaryCondition and another. It returns true if they are equal and false if they are not.

Specified by:

equals in interface IVizObject

Overrides:

equals in class VizObject

Parameters:

otherObject - The other Object that should be compared with this one.

Returns:

True if the Objects are equal, false otherwise.

See Also:

Identifiable#equals(Object otherObject)

copy

public void copy(BoundaryCondition condition)

This operation copies the contents of a BoundaryCondition into the current object using a deep copy.

Parameters:

condition - The Object from which the values should be copied.

clone

public java.lang.Object clone()

This operation returns a clone of the BoundaryCondition using a deep copy.

Specified by:

clone in interface IVizObject

Overrides:

clone in class VizObject

Returns:

The new clone.