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

Class PolygonProperties

java.lang.Object

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

public class PolygonProperties
extends java.lang.Object

A container for the material ID and group number of every polygon, as defined in the MESH DATA section of a Nek5000 reafile. Example:

ELEMENT 44 [ 1R] GROUP 0

For this Polygon, materialId = "1R", groupNum = 0.

Author:

Anna Wojtowicz

Constructor Summary

Constructors

Constructor and Description
PolygonProperties() A nullary constructor that sets default values.
PolygonProperties(java.lang.String id, int group) The default, parameterized constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() This operation returns a clone of the PolygonProperties using a deep copy.
void	copy(PolygonProperties properties) This operation copies the contents of a PolygonProperties into the current object using a deep copy.
boolean	equals(java.lang.Object otherObject) This operation is used to check equality between this PolygonProperties and another PolygonProperties.
int	getGroupNum() Returns the group number as an int.
java.lang.String	getMaterialId() Returns the material ID as a string.
int	hashCode() This operation returns the hash value of the PolygonProperties.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolygonProperties

public PolygonProperties()

A nullary constructor that sets default values.

PolygonProperties

public PolygonProperties(java.lang.String id,
                         int group)

The default, parameterized constructor.

Parameters:

id -

Material ID of the polygon. Must be between 1-4 chars long.

group -

Group number of the polygon. Must be no more than 5 digits.

Method Detail

getMaterialId

public java.lang.String getMaterialId()

Returns the material ID as a string.

Returns:

The material ID of the polygon.

getGroupNum

public int getGroupNum()

Returns the group number as an int.

Returns:

The group number of the polygon.

equals

public boolean equals(java.lang.Object otherObject)

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

Overrides:

equals in class java.lang.Object

Parameters:

otherObject -

The other Object that should be compared with this one.

Returns:

True if the Objects are equal, false otherwise.

hashCode

public int hashCode()

This operation returns the hash value of the PolygonProperties.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash of the Object.

clone

public java.lang.Object clone()

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

Overrides:

clone in class java.lang.Object

Returns:

The new clone.

copy

public void copy(PolygonProperties properties)

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

Parameters:

properties -

The Object from which the values should be copied.