com.partnersoft.geometry.measurement

Class ScaleRatio

java.lang.Object

com.partnersoft.geometry.measurement.ScaleRatio

All Implemented Interfaces:

Immutable

public class ScaleRatio
extends java.lang.Object
implements Immutable

A dimensionless scale used for describing the relationship between a distance measurement on a model and the corresponding distance measurement on the thing being modelled.

The canonical representation uses A:B, where A is the model measure and B is the real measure. Floating-point numbers are used to represent, which may provide unsatisfactorily detailed representations in simple cases.

There are a number of standard notations; we use the colon notation e.g. 1:45 meaning that a foot on the model is equal to 45 feet in reality (or an inch on the model is 45 inches in reality - the units don't matter as long as the same ones are used on both sides).

Convenience methods for converting between various other scale representations are provided.

See http://en.wikipedia.org/wiki/Scale_%28ratio%29 for a longer discussion.

Copyright 2012 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
ScaleRatio(Cog state)
ScaleRatio(double a, double b)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object nother)
static ScaleRatio	forLinearMeasurements(LinearMeasurement aMeasurement, LinearMeasurement bMeasurement)
static ScaleRatio	forQuotient(double quotient)
static ScaleRatio	forTerms(double a, double b)
double	getA() The model dimension quantity.
double	getB() The original dimension quantity.
double	getQuotient()
int	hashCode()
ScaleRatio	normalized() Normalized such that A = 1.0.
Cog	toCog()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScaleRatio

public ScaleRatio(double a,
          double b)

ScaleRatio

public ScaleRatio(Cog state)

Method Detail

toCog

public Cog toCog()

forQuotient

public static ScaleRatio forQuotient(double quotient)

forTerms

public static ScaleRatio forTerms(double a,
                  double b)

forLinearMeasurements

public static ScaleRatio forLinearMeasurements(LinearMeasurement aMeasurement,
                               LinearMeasurement bMeasurement)

normalized

public ScaleRatio normalized()

Normalized such that A = 1.0.

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object nother)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getA

public double getA()

The model dimension quantity.

getB

public double getB()

The original dimension quantity.

getQuotient

public double getQuotient()