Main Page | Packages | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

ikayaki.NormalizedValue Class Reference

List of all members.

Public Member Functions

 NormalizedValue (String caption, String description)
final Double getValue (MeasurementStep step)
Override String getUnit (Project project)

Protected Member Functions

abstract Double getValue0 (MeasurementStep step)

Static Private Member Functions

static Double normalize (MeasurementStep step, Double value)

Detailed Description

Specializes the MeasurementValue class with automatic value normalization.

Author:
Esko Luontola

Definition at line 528 of file MeasurementValue.java.


Constructor & Destructor Documentation

ikayaki.NormalizedValue.NormalizedValue String  caption,
String  description
 

Definition at line 530 of file MeasurementValue.java.


Member Function Documentation

Override String ikayaki.NormalizedValue.getUnit Project  project  ) 
 

Returns mA/m or Am^2/kg depending on the normalization that the project uses.

Definition at line 558 of file MeasurementValue.java.

References ikayaki.Project.getNormalization(), ikayaki.Project.MASS, and ikayaki.Project.VOLUME.

Here is the call graph for this function:

final Double ikayaki.NormalizedValue.getValue MeasurementStep  step  ) 
 

Calculates a specific normalized value from a measurement step.

Parameters:
step the step from which the value will be calculated.
Returns:
the calculated value, or null if it was not possible to calculate it. The unit is mA/m or Am^2/kg depenging on the normalization that was used.
Exceptions:
NullPointerException if step is null.

Definition at line 542 of file MeasurementValue.java.

References ikayaki.NormalizedValue.getValue0(), and ikayaki.NormalizedValue.normalize().

Here is the call graph for this function:

abstract Double ikayaki.NormalizedValue.getValue0 MeasurementStep  step  )  [protected, pure virtual]
 

Calculates a specific NOT NORMALIZED value from a measurement step.

Parameters:
step the step from which the value will be calculated.
Returns:
the calculated value, or null if it was not possible to calculate it. The unit is Am^2.
Exceptions:
NullPointerException if step is null.

Referenced by ikayaki.NormalizedValue.getValue().

static Double ikayaki.NormalizedValue.normalize MeasurementStep  step,
Double  value
[static, private]
 

Normalizes a value by mass or volume, as specified in the project or step.

Parameters:
step the step whose value is being normalized.
value the value to be normalised. The unit is Am^2.
Returns:
the normalized value if the mass/volume was specified, otherwise null. The unit is mAm^2 divided by m^3 or kg depending on the used normalization.

Definition at line 579 of file MeasurementValue.java.

References ikayaki.Project.getMass(), ikayaki.MeasurementStep.getMass(), ikayaki.Project.getNormalization(), ikayaki.MeasurementStep.getProject(), ikayaki.Project.getVolume(), ikayaki.MeasurementStep.getVolume(), ikayaki.Project.MASS, and ikayaki.Project.VOLUME.

Referenced by ikayaki.NormalizedValue.getValue().

Here is the call graph for this function:


The documentation for this class was generated from the following file:
Generated on Fri May 6 16:00:41 2005 for Squid by  doxygen 1.4.1