public class BoundaryCondition extends ICEObject
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.
iComponentListener
Constructor and Description |
---|
BoundaryCondition()
The nullary constructor.
|
BoundaryCondition(BoundaryConditionType type)
Constructs a BoundaryCondition with the specified BoundaryConditionType.
|
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.
|
copy, getDescription, getId, getName, register, setDescription, setId, setName, unregister, update
public BoundaryCondition()
The nullary constructor. Sets all values to their defaults (the type is None, and the values are all 0).
public BoundaryCondition(BoundaryConditionType type)
Constructs a BoundaryCondition with the specified BoundaryConditionType. Every other feature of the BoundaryCondition is set to its default value.
type
- The initial BoundaryConditionType.public BoundaryConditionType getType()
Gets the type of the BoundaryCondition.
public void setType(BoundaryConditionType type)
Sets the type of the BoundaryCondition.
type
- The new BoundaryConditionType.public java.util.ArrayList<java.lang.Float> getValues()
Gets the parameter values for this BoundaryCondition.
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.
values
- The new parameter values for the BoundaryCondition.public int hashCode()
This operation returns the hash value of the BoundaryCondition.
hashCode
in interface Identifiable
hashCode
in class ICEObject
Identifiable.hashCode()
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.
equals
in interface Identifiable
equals
in class ICEObject
otherObject
- The other Object that should be compared with this one.Identifiable.equals(Object otherObject)
public void copy(BoundaryCondition condition)
This operation copies the contents of a BoundaryCondition into the current object using a deep copy.
condition
- The Object from which the values should be copied.public java.lang.Object clone()
This operation returns a clone of the BoundaryCondition using a deep copy.
clone
in interface Identifiable
clone
in class ICEObject