hep.wired.heprep.projection

Class VariableProjection

java.lang.Object

hep.wired.heprep.projection.AbstractProjection

hep.wired.heprep.projection.VariableProjection

All Implemented Interfaces:

NamedVariables, Projection, ProjectionFeature, Feature, UVWindices, WiredRegistry.ID, XYZindices, org.freehep.xml.io.XMLIO

Direct Known Subclasses:

ClockProjection, CylindricalFishEyeProjection, RhoZProjection

public abstract class VariableProjection
extends AbstractProjection
implements NamedVariables

Base class for projections based on named variables.

Version:

$Id: VariableProjection.java 8598 2006-08-14 20:38:02Z duns $

Author:

Mark Donszelmann

Field Summary

Fields inherited from class hep.wired.heprep.projection.AbstractProjection

defaultProjections

Fields inherited from interface hep.wired.util.XYZindices

X, Y, Z

Fields inherited from interface hep.wired.util.UVWindices

U, V, W

Constructor Summary

Constructors

Constructor and Description
VariableProjection(String name) Creates a named projection.

Method Summary

Methods

Modifier and Type	Method and Description
protected BooleanVariable	addVariable(String name, boolean def, String description) Adds a named variable with default value.
void	addVariable(String name, double add)
protected DoubleVariable	addVariable(String name, double min, double max, double def, String unit, String description) Adds a named variable with minimum, maximum and default value.
void	addVariable(String name, int add)
protected IntegerVariable	addVariable(String name, int min, int max, int def, String unit, String description) Adds a named variable with minimum, maximum and default value.
boolean	exists(String name) Return true if variable with name exists.
boolean	getBooleanVariable(String name)
String	getDescription(String name) Return the description
double	getDoubleVariable(String name)
int	getIntegerVariable(String name)
String	getName() Returns the name of the projection.
String	getUnit(String name) Return the unit, or null;
Set	getVariableNames() Return set of variable names
Collection	getVariables() Returns a list of all variables
void	multiplyVariable(String name, double factor)
void	multiplyVariable(String name, int factor)
void	restore(org.freehep.xml.io.XMLIOManager xmlioManager, org.jdom.Element nodeEl)
void	save(org.freehep.xml.io.XMLIOManager xmlioManager, org.jdom.Element nodeEl)
void	setVariable(String name, boolean value) Sets the value of a named variable.
void	setVariable(String name, double value) Sets the value of a named variable.
void	setVariable(String name, int value) Sets the value of a named variable.
String	toString() Returns name of projection

Methods inherited from class hep.wired.heprep.projection.AbstractProjection

copy, deltaTransform, getFeature, getFormula, getID, getViewPort, setViewPort, supports, transform, transform, transform, transform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VariableProjection

public VariableProjection(String name)

Creates a named projection.

Method Detail

getName

public String getName()

Description copied from interface: Projection

Returns the name of the projection.

Specified by:

getName in interface Projection

Overrides:

getName in class AbstractProjection

addVariable

protected DoubleVariable addVariable(String name,
                         double min,
                         double max,
                         double def,
                         String unit,
                         String description)

Adds a named variable with minimum, maximum and default value.

addVariable

protected IntegerVariable addVariable(String name,
                          int min,
                          int max,
                          int def,
                          String unit,
                          String description)

Adds a named variable with minimum, maximum and default value.

addVariable

protected BooleanVariable addVariable(String name,
                          boolean def,
                          String description)

Adds a named variable with default value.

exists

public boolean exists(String name)

Return true if variable with name exists.

Specified by:

exists in interface NamedVariables

getVariableNames

public Set getVariableNames()

Return set of variable names

Specified by:

getVariableNames in interface NamedVariables

getVariables

public Collection getVariables()

Returns a list of all variables

getUnit

public String getUnit(String name)

Return the unit, or null;

getDescription

public String getDescription(String name)

Return the description

getDoubleVariable

public double getDoubleVariable(String name)

Specified by:

getDoubleVariable in interface NamedVariables

getIntegerVariable

public int getIntegerVariable(String name)

Specified by:

getIntegerVariable in interface NamedVariables

getBooleanVariable

public boolean getBooleanVariable(String name)

Specified by:

getBooleanVariable in interface NamedVariables

setVariable

public void setVariable(String name,
               double value)

Sets the value of a named variable.

Specified by:

setVariable in interface NamedVariables

setVariable

public void setVariable(String name,
               int value)

Sets the value of a named variable.

Specified by:

setVariable in interface NamedVariables

setVariable

public void setVariable(String name,
               boolean value)

Sets the value of a named variable.

Specified by:

setVariable in interface NamedVariables

multiplyVariable

public void multiplyVariable(String name,
                    double factor)

Specified by:

multiplyVariable in interface NamedVariables

multiplyVariable

public void multiplyVariable(String name,
                    int factor)

Specified by:

multiplyVariable in interface NamedVariables

addVariable

public void addVariable(String name,
               double add)

Specified by:

addVariable in interface NamedVariables

addVariable

public void addVariable(String name,
               int add)

Specified by:

addVariable in interface NamedVariables

toString

public String toString()

Description copied from class: AbstractProjection

Returns name of projection

Overrides:

toString in class AbstractProjection

save

public void save(org.freehep.xml.io.XMLIOManager xmlioManager,
        org.jdom.Element nodeEl)

Specified by:

save in interface org.freehep.xml.io.XMLIO

Overrides:

save in class AbstractProjection

restore

public void restore(org.freehep.xml.io.XMLIOManager xmlioManager,
           org.jdom.Element nodeEl)

Specified by:

restore in interface org.freehep.xml.io.XMLIO

Overrides:

restore in class AbstractProjection