jscicalc.expression.Variable Class Reference

This class represents an output variable. More...

Inheritance diagram for jscicalc.expression.Variable:

Collaboration diagram for jscicalc.expression.Variable:

[legend]

List of all members.

Public Member Functions
	Variable (jscicalc.pobject.Variable variable)
	Construct from a Variable of jscicalc.pobject.
jscicalc.pobject.PObject	pObject ()
	Get the jscicalc.pobject.Variable represented by this.
char	get ()
	Useful to create a representation.
String	name ()
	Useful to create a representation.
String[]	name_array ()
	Useful to create a representation.
jscicalc.StringArray	toHTMLSubString (int maxChars, int precision, final Base base, final Notation notation, double polarFactor)
	Function to create an HTML string representation of the variable The arguments are ignored because they are only needed for a Complex.
jscicalc.StringArray	toHTMLParenString (int maxChars, int precision, final Base base, final Notation notation, double polarFactor)
Product	negate ()
	Return the negative of this.
int	compareTo (Variable variable)
	The comparison operator.
OObject	substitute (jscicalc.Substitution substitution)
	Carry out substitutions as specified by Substituion object.
Private Attributes
jscicalc.pobject.Variable	variable
	The variable is a reference to a pobject Variable.

---

Detailed Description

This class represents an output variable.

See also:

OObject

Author:

J. D. Lamb

Version:

Revision

1.5

---

Constructor & Destructor Documentation

jscicalc.expression.Variable.Variable

(

jscicalc.pobject.Variable

variable

)

Construct from a Variable of jscicalc.pobject.

Parameters:

variable

The PObject representation.

References jscicalc.expression.Variable.variable.

---

Member Function Documentation

jscicalc.pobject.PObject jscicalc.expression.Variable.pObject

(

)

Get the jscicalc.pobject.Variable represented by this.

Returns:

The variable as PObject

References jscicalc.expression.Variable.variable.

char jscicalc.expression.Variable.get

(

)

Useful to create a representation.

Returns:

The character reprenting this Variable

References jscicalc.expression.Variable.get(), and jscicalc.expression.Variable.variable.

Referenced by jscicalc.expression.Variable.compareTo(), and jscicalc.expression.Variable.get().

String jscicalc.expression.Variable.name

(

)

Useful to create a representation.

Returns:

A String reprenting this Variable

References jscicalc.expression.Variable.name(), and jscicalc.expression.Variable.variable.

Referenced by jscicalc.Substitution.add(), jscicalc.expression.Variable.name(), and jscicalc.expression.Variable.substitute().

String [] jscicalc.expression.Variable.name_array

(

)

Useful to create a representation.

Returns:

An array of String objects reprenting this Variable

References jscicalc.expression.Variable.name_array(), and jscicalc.expression.Variable.variable.

Referenced by jscicalc.expression.Variable.name_array(), and jscicalc.expression.Variable.toHTMLSubString().

jscicalc.StringArray jscicalc.expression.Variable.toHTMLSubString	(	int	maxChars,
		int	precision,
		final Base	base,
		final Notation	notation,
		double	polarFactor
	)

Function to create an HTML string representation of the variable The arguments are ignored because they are only needed for a Complex.

Parameters:

	maxChars	ignored
	precision	ignored
	base	ignored
	notation	ignored
	polarFactor	ignored

Returns:

a String representing the variable.

References jscicalc.expression.Variable.name_array().

Referenced by jscicalc.expression.Variable.toHTMLParenString().

jscicalc.StringArray jscicalc.expression.Variable.toHTMLParenString	(	int	maxChars,
		int	precision,
		final Base	base,
		final Notation	notation,
		double	polarFactor
	)

References jscicalc.expression.Variable.toHTMLSubString().

Product jscicalc.expression.Variable.negate

(

)

[virtual]

Return the negative of this.

Returns:

The negative of this

Implements jscicalc.expression.Expression.

References jscicalc.expression.Product.negate().

int jscicalc.expression.Variable.compareTo

(

Variable

variable

)

The comparison operator.

Parameters:

variable

The Variable to be compared.

Returns:

integer indicating how expression is compared to this.

References jscicalc.expression.Variable.get().

OObject jscicalc.expression.Variable.substitute

(

jscicalc.Substitution

substitution

)

Carry out substitutions as specified by Substituion object.

In this case any variable whose name matches this is substituted with the oobject in substitution.

Parameters:

substitution

The object specifying the substitutions

Returns:

The OObject after the substitution

References jscicalc.expression.Variable.name().

---

Member Data Documentation

jscicalc.pobject.Variable jscicalc.expression.Variable.variable [private]

The variable is a reference to a pobject Variable.

Referenced by jscicalc.expression.Variable.get(), jscicalc.expression.Variable.name(), jscicalc.expression.Variable.name_array(), jscicalc.expression.Variable.pObject(), and jscicalc.expression.Variable.Variable().

---

The documentation for this class was generated from the following file:

• expression/Variable.java