Package com.flir.thermalsdk.image

Class CompassInformation

java.lang.Object
com.flir.thermalsdk.image.CompassInformation
public final class CompassInformation extends Object
Class provides basic compass information.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompassInformation(int degrees, int pitch, int roll, int tilt)
    Creates a new instance of compass information based on provided data.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    getDegrees()
    Compass direction in degrees, has to be in range of [0, 359].
    int
    getPitch()
    Sensor pitch in degrees, has to be in range of [-90, 90].
    int
    getRoll()
    The terminal's rotation in degrees around its own longitudinal axis, has to be in range of [-180, 180].
    int
    getTilt()
    Compass tilt in degrees, has to be in range of [0, 360].
    int
    hashCode()
     
    void
    setDegrees(int degrees)
    Compass direction in degrees, has to be in range of [0, 359].
    void
    setPitch(int pitch)
    Sensor pitch in degrees, has to be in range of [-90, 90].
    void
    setRoll(int roll)
    The terminal's rotation in degrees around its own longitudinal axis, has to be in range of [-180, 180].
    void
    setTilt(int tilt)
    Compass tilt in degrees, has to be in range of [0, 360].
    String
    toString()
     

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CompassInformation

      public CompassInformation(int degrees, int pitch, int roll, int tilt)
      Creates a new instance of compass information based on provided data.
      Parameters:
      degrees - Compass direction in degrees, has to be in range of [0, 359].
      pitch - Sensor pitch in degrees, has to be in range of [-90, 90].
      roll - The terminal's rotation in degrees around its own longitudinal axis, has to be in range of [-180, 180]
      tilt - Compass tilt in degrees, has to be in range of [0, 360].
      Throws:
      IllegalArgumentException - if any of the provided value is out of range

  • Method Details

    • getDegrees

      public int getDegrees()
      Compass direction in degrees, has to be in range of [0, 359].

    • setDegrees

      public void setDegrees(int degrees)
      Compass direction in degrees, has to be in range of [0, 359].
      Throws:
      IllegalArgumentException - if the provided value is out of range

    • getPitch

      public int getPitch()
      Sensor pitch in degrees, has to be in range of [-90, 90].

    • setPitch

      public void setPitch(int pitch)
      Sensor pitch in degrees, has to be in range of [-90, 90].
      Throws:
      IllegalArgumentException - if the provided value is out of range

    • getRoll

      public int getRoll()
      The terminal's rotation in degrees around its own longitudinal axis, has to be in range of [-180, 180].

    • setRoll

      public void setRoll(int roll)
      The terminal's rotation in degrees around its own longitudinal axis, has to be in range of [-180, 180].
      Throws:
      IllegalArgumentException - if the provided value is out of range

    • getTilt

      public int getTilt()
      Compass tilt in degrees, has to be in range of [0, 360].

    • setTilt

      public void setTilt(int tilt)
      Compass tilt in degrees, has to be in range of [0, 360].
      Throws:
      IllegalArgumentException - if the provided value is out of range

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object