Package com.irurueta.navigation.inertial.calibration

Class MagneticFluxDensityTriad

java.lang.Object

com.irurueta.navigation.inertial.calibration.Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

com.irurueta.navigation.inertial.calibration.MagneticFluxDensityTriad

All Implemented Interfaces:

Serializable, Cloneable

public class MagneticFluxDensityTriad
extends Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>
implements Cloneable

Contains a triad of magnetic flux density measurements.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final com.irurueta.units.MagneticFluxDensityUnit	DEFAULT_UNIT	Default magnetic flux density unit.
private static final long	serialVersionUID	Serialization version.

Fields inherited from class com.irurueta.navigation.inertial.calibration.Triad

COMPONENTS

Constructor Summary

Constructors

Constructor	Description
MagneticFluxDensityTriad()	Constructor.
MagneticFluxDensityTriad(double valueX, double valueY, double valueZ)	Constructor.
MagneticFluxDensityTriad(MagneticFluxDensityTriad other)	Copy constructor.
MagneticFluxDensityTriad(com.irurueta.units.MagneticFluxDensity measurementX, com.irurueta.units.MagneticFluxDensity measurementY, com.irurueta.units.MagneticFluxDensity measurementZ)	Constructor.
MagneticFluxDensityTriad(com.irurueta.units.MagneticFluxDensityUnit unit)	Constructor.
MagneticFluxDensityTriad(com.irurueta.units.MagneticFluxDensityUnit unit, double valueX, double valueY, double valueZ)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Object	clone()	Makes a copy of this instance.
MagneticFluxDensityTriad	copy()	Creates and returns a new instance having exactly the same contents as this instance.
com.irurueta.units.MagneticFluxDensity	getMeasurementNorm()	Gets norm as a magnetic flux density.
com.irurueta.units.MagneticFluxDensity	getMeasurementX()	Gets x coordinate of measurement value.
void	getMeasurementX(com.irurueta.units.MagneticFluxDensity result)	Gets x coordinate of measurement value.
com.irurueta.units.MagneticFluxDensity	getMeasurementY()	Gets y coordinate of measurement value.
void	getMeasurementY(com.irurueta.units.MagneticFluxDensity result)	Gets y coordinate of measurement value.
com.irurueta.units.MagneticFluxDensity	getMeasurementZ()	Gets z coordinate of measurement value.
void	getMeasurementZ(com.irurueta.units.MagneticFluxDensity result)	Gets z coordinate of measurement value.
void	setMeasurementCoordinates(com.irurueta.units.MagneticFluxDensity measurementX, com.irurueta.units.MagneticFluxDensity measurementY, com.irurueta.units.MagneticFluxDensity measurementZ)	Sets measurement coordinates.
void	setMeasurementX(com.irurueta.units.MagneticFluxDensity measurementX)	Sets x coordinate of measurement value.
void	setMeasurementY(com.irurueta.units.MagneticFluxDensity measurementY)	Sets y coordinate of measurement value.
void	setMeasurementZ(com.irurueta.units.MagneticFluxDensity measurementZ)	Sets z coordinate of measurement value.

Methods inherited from class com.irurueta.navigation.inertial.calibration.Triad

copyFrom, copyTo, equals, equals, equals, getMeasurementNorm, getNorm, getSqrNorm, getUnit, getValuesAsArray, getValuesAsArray, getValuesAsMatrix, getValuesAsMatrix, getValueX, getValueY, getValueZ, hashCode, setUnit, setValueCoordinates, setValueCoordinates, setValueCoordinates, setValueCoordinatesAndUnit, setValueX, setValueY, setValueZ

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_UNIT

public static final com.irurueta.units.MagneticFluxDensityUnit DEFAULT_UNIT

Default magnetic flux density unit.

serialVersionUID

private static final long serialVersionUID

Serialization version. This is used to ensure compatibility of deserialization of permanently stored serialized instances.

See Also:

• Constant Field Values

Constructor Details

MagneticFluxDensityTriad

public MagneticFluxDensityTriad()

Constructor.

MagneticFluxDensityTriad

public MagneticFluxDensityTriad(com.irurueta.units.MagneticFluxDensityUnit unit)

Constructor.

Parameters:

unit - magnetic flux density unit for stored values.

MagneticFluxDensityTriad

public MagneticFluxDensityTriad(double valueX,
 double valueY,
 double valueZ)

Constructor.

Parameters:

valueX - x-coordinate of measurement value expressed in default unit.

valueY - y-coordinate of measurement value expressed in default unit.

valueZ - z-coordinate of measurement value expressed in default unit.

MagneticFluxDensityTriad

public MagneticFluxDensityTriad(com.irurueta.units.MagneticFluxDensityUnit unit,
 double valueX,
 double valueY,
 double valueZ)

Constructor.

Parameters:

unit - magnetic flux density unit for stored values.

valueX - x-coordinate of measurement value expressed in provided unit.

valueY - y-coordinate of measurement value expressed in provided unit.

valueZ - z-coordinate of measurement value expressed in provided unit.

MagneticFluxDensityTriad

public MagneticFluxDensityTriad(com.irurueta.units.MagneticFluxDensity measurementX,
 com.irurueta.units.MagneticFluxDensity measurementY,
 com.irurueta.units.MagneticFluxDensity measurementZ)

Constructor.

Parameters:

measurementX - x-coordinate of measurement.

measurementY - y-coordinate of measurement.

measurementZ - z-coordinate of measurement.

MagneticFluxDensityTriad

public MagneticFluxDensityTriad(MagneticFluxDensityTriad other)

Copy constructor.

Parameters:

other - instance to copy from.

Method Details

getMeasurementX

public com.irurueta.units.MagneticFluxDensity getMeasurementX()

Gets x coordinate of measurement value.

Specified by:

getMeasurementX in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Returns:

x coordinate of measurement value.

getMeasurementX

public void getMeasurementX(com.irurueta.units.MagneticFluxDensity result)

Gets x coordinate of measurement value.

Specified by:

getMeasurementX in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Parameters:

result - instance where x coordinate of measurement value will be stored.

setMeasurementX

public void setMeasurementX(com.irurueta.units.MagneticFluxDensity measurementX)

Sets x coordinate of measurement value.

Specified by:

setMeasurementX in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Parameters:

measurementX - x coordinate of measurement value.

getMeasurementY

public com.irurueta.units.MagneticFluxDensity getMeasurementY()

Gets y coordinate of measurement value.

Specified by:

getMeasurementY in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Returns:

y coordinate of measurement value.

getMeasurementY

public void getMeasurementY(com.irurueta.units.MagneticFluxDensity result)

Gets y coordinate of measurement value.

Specified by:

getMeasurementY in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Parameters:

result - instance where y coordinate of measurement value will be stored.

setMeasurementY

public void setMeasurementY(com.irurueta.units.MagneticFluxDensity measurementY)

Sets y coordinate of measurement value.

Specified by:

setMeasurementY in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Parameters:

measurementY - y coordinate of measurement value.

getMeasurementZ

public com.irurueta.units.MagneticFluxDensity getMeasurementZ()

Gets z coordinate of measurement value.

Specified by:

getMeasurementZ in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Returns:

z coordinate of measurement value.

getMeasurementZ

public void getMeasurementZ(com.irurueta.units.MagneticFluxDensity result)

Gets z coordinate of measurement value.

Specified by:

getMeasurementZ in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Parameters:

result - instance where z coordinate of measurement value will be stored.

setMeasurementZ

public void setMeasurementZ(com.irurueta.units.MagneticFluxDensity measurementZ)

Sets z coordinate of measurement value.

Specified by:

setMeasurementZ in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Parameters:

measurementZ - z coordinate of measurement value.

setMeasurementCoordinates

public void setMeasurementCoordinates(com.irurueta.units.MagneticFluxDensity measurementX,
 com.irurueta.units.MagneticFluxDensity measurementY,
 com.irurueta.units.MagneticFluxDensity measurementZ)

Sets measurement coordinates.

Specified by:

setMeasurementCoordinates in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Parameters:

measurementX - x coordinate of measurement value.

measurementY - y coordinate of measurement value.

measurementZ - z coordinate of measurement value.

getMeasurementNorm

public com.irurueta.units.MagneticFluxDensity getMeasurementNorm()

Gets norm as a magnetic flux density.

Specified by:

getMeasurementNorm in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Returns:

magnetic flux density containing triad norm.

copy

public MagneticFluxDensityTriad copy()

Creates and returns a new instance having exactly the same contents as this instance.

Specified by:

copy in class Triad<com.irurueta.units.MagneticFluxDensityUnit,com.irurueta.units.MagneticFluxDensity,MagneticFluxDensityTriad>

Returns:

a copy of this instance.

clone

protected Object clone()
                throws CloneNotSupportedException

Makes a copy of this instance.

Overrides:

clone in class Object

Returns:

a copy of this instance.

Throws:

CloneNotSupportedException - if clone fails for some reason.