Package jmri.jmrix.rps

Class Measurement

java.lang.Object

jmri.jmrix.rps.Measurement

public class Measurement
extends Object

Encodes a single measurement point for RPS.

Immutable

Field Summary

Fields

Modifier and Type	Field	Description
protected int	code
(package private) Reading	r
(package private) String	source
(package private) boolean	valid
(package private) double	vsound
(package private) double	x
(package private) double	y
(package private) double	z

Constructor Summary

Constructors

Constructor	Description
Measurement(Reading r)
Measurement(Reading r, double x, double y, double z, double vsound, int code, String source)

Method Summary

Modifier and Type	Method	Description
int	getCode()	Error code, defined specifically by generator.
String	getId()	Return the ID int of the transmitter this measurement describes.
javax.vecmath.Point3d	getPoint()
Reading	getReading()	Return the Reading this measurement made from.
String	getSource()	Get name of the source.
javax.vecmath.Vector3d	getVector()
double	getVSound()
double	getX()
double	getY()
double	getZ()
boolean	isOkPoint()	Should this be considered a valid measurement?
boolean	isValidPosition()
void	setValidPosition(boolean val)
String	textCode()	Get the error code as a human-readable string.
String	toString()
(package private) double	truncate(double x)

Methods inherited from class java.lang.Object

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

Field Details

valid

boolean valid

x

double x

y

double y

z

double z

vsound

double vsound

code

protected int code

source

String source

r

Reading r

Constructor Details

Measurement

public Measurement(Reading r)

Measurement

public Measurement(Reading r,
 double x,
 double y,
 double z,
 double vsound,
 int code,
 String source)

Method Details

getReading

public Reading getReading()

Return the Reading this measurement made from.

By definition, Reading objects are immutable

Returns:

the reading.

getId

public String getId()

Return the ID int of the transmitter this measurement describes.

Returns:

transmitter ID.

getX

public double getX()

getY

public double getY()

getZ

public double getZ()

getVSound

public double getVSound()

isValidPosition

public boolean isValidPosition()

setValidPosition

public void setValidPosition(boolean val)

getCode

public int getCode()

Error code, defined specifically by generator.

Returns:

error code.

isOkPoint

public boolean isOkPoint()

Should this be considered a valid measurement?

Returns:

if getCode greater 0.

textCode

public String textCode()

Get the error code as a human-readable string.

Returns:

readable error code.

getPoint

public javax.vecmath.Point3d getPoint()

getVector

public javax.vecmath.Vector3d getVector()

getSource

public String getSource()

Get name of the source.

Returns:

source name.

toString

public String toString()

Overrides:

toString in class Object

truncate

double truncate(double x)