New mxConstraint() interface implementation
[openmx:openmx.git] / man / MxConstraint-class.Rd
1 \name{MxConstraint-class}
2 \alias{MxConstraint}
3
4 \title{MxConstraint Class}
5
6 \description{
7    MxConstraint is an S4 class. An MxConstraint object 
8    is a \link[=Named-entity]{named entity}. New instances of this class can
9    be created using the function \link{mxConstraint}.
10 }
11
12 \details{
13 The MxConstraint class has the following slots:
14
15   \tabular{rcl}{
16         \tab \tab \cr
17         name \tab - \tab The name of the object \cr
18         formula \tab - \tab The R expression to be evaluated
19   }
20   
21 The \sQuote{name} slot is the name of the MxConstraint object. Use of MxConstraint objects in other functions in the \link{OpenMx} library may require reference by name.
22
23 The \sQuote{formula} slot is an expression containing the expression to be evaluated. These objects are operated on or related to one another using one or more operations detailed in the \code{\link{mxConstraint}} help file.
24
25 Slots may be referenced with the @ symbol. See the documentation for \link[methods]{Classes} and the examples in the \link{mxConstraint} document for more information.
26 }
27
28 \references{
29 The OpenMx User's guide can be found at http://openmx.psyc.virginia.edu/documentation.
30 }
31
32 \seealso{
33 \link{mxConstraint} for the function that creates MxConstraint objects. \link{MxAlgebra} and \link{MxMatrix} for objects which may be entered as arguments in the 'alg' and 'alg2' arguments, and \link{mxAlgebra} and \link{mxMatrix} for the functions that create them. More information about the OpenMx package may be found \link[=OpenMx]{here}. 
34 }