org.jscience.physics.solids.constraint
Class GlobalConstraint

java.lang.Object
  extended by org.jscience.physics.solids.AtlasObject
      extended by org.jscience.physics.solids.AtlasConstraint
          extended by org.jscience.physics.solids.constraint.GlobalConstraint
All Implemented Interfaces:
java.lang.Comparable

public class GlobalConstraint
extends AtlasConstraint

Constrains an entire model's motion in the specified degrees of freedom. The model to be constrained is the owning parent of this AtlasObject.


Field Summary
protected static java.lang.String TYPE
          DOCUMENT ME!
 
Constructor Summary
GlobalConstraint(java.lang.String id, int dof)
          Constrains the specified model in the degree of freedom.
GlobalConstraint(java.lang.String id, int[] dof)
          Constrains a parent model in the degree of freedom.
 
Method Summary
 void contributeConstraint(SolutionMatrices m)
          DOCUMENT ME!
 int[] getConstrainedDOF()
          Returns which degrees of freedom are constrained.
 java.lang.String getType()
          DOCUMENT ME!
 org.jdom.Element loadJDOMElement()
          Marshalls object to XML.
 java.lang.String toString()
          DOCUMENT ME!
static AtlasObject unloadJDOMElement(AtlasModel parent, org.jdom.Element e)
          Unmarshalls the object from XML.
 
Methods inherited from class org.jscience.physics.solids.AtlasObject
compareTo, equals, getId, getParentModel, populateGeometry, setId, setParentModel
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

protected static java.lang.String TYPE
DOCUMENT ME!

Constructor Detail

GlobalConstraint

public GlobalConstraint(java.lang.String id,
                        int dof)
Constrains the specified model in the degree of freedom. The degree of freedom to be constrained should be an integer.


GlobalConstraint

public GlobalConstraint(java.lang.String id,
                        int[] dof)
Constrains a parent model in the degree of freedom. The degree of freedom to be constrained should be an integer.

Method Detail

contributeConstraint

public void contributeConstraint(SolutionMatrices m)
DOCUMENT ME!

Specified by:
contributeConstraint in class AtlasConstraint
Parameters:
m - DOCUMENT ME!

getType

public java.lang.String getType()
DOCUMENT ME!

Specified by:
getType in class AtlasObject
Returns:
DOCUMENT ME!

getConstrainedDOF

public int[] getConstrainedDOF()
Returns which degrees of freedom are constrained.

Returns:
DOCUMENT ME!

toString

public java.lang.String toString()
DOCUMENT ME!

Overrides:
toString in class AtlasObject
Returns:
DOCUMENT ME!

loadJDOMElement

public org.jdom.Element loadJDOMElement()
Marshalls object to XML.

Overrides:
loadJDOMElement in class AtlasObject
Returns:
DOCUMENT ME!

unloadJDOMElement

public static AtlasObject unloadJDOMElement(AtlasModel parent,
                                            org.jdom.Element e)
Unmarshalls the object from XML.

Parameters:
parent - DOCUMENT ME!
e - DOCUMENT ME!
Returns:
DOCUMENT ME!