com.garmin.fit
Class MagnetometerDataMesg

java.lang.Object
  extended by com.garmin.fit.Mesg
      extended by com.garmin.fit.MagnetometerDataMesg

public class MagnetometerDataMesg
extends Mesg


Field Summary
static int CalibratedMagXFieldNum
           
static int CalibratedMagYFieldNum
           
static int CalibratedMagZFieldNum
           
protected static Mesg magnetometerDataMesg
           
static int MagXFieldNum
           
static int MagYFieldNum
           
static int MagZFieldNum
           
static int SampleTimeOffsetFieldNum
           
static int TimestampFieldNum
           
static int TimestampMsFieldNum
           
 
Fields inherited from class com.garmin.fit.Mesg
developerFields, fields, localNum, name, num, systemTimeOffset
 
Constructor Summary
MagnetometerDataMesg()
           
MagnetometerDataMesg(Mesg mesg)
           
 
Method Summary
 java.lang.Float[] getCalibratedMagX()
           
 java.lang.Float getCalibratedMagX(int index)
          Get calibrated_mag_x field Units: G Comment: Calibrated Magnetometer reading
 java.lang.Float[] getCalibratedMagY()
           
 java.lang.Float getCalibratedMagY(int index)
          Get calibrated_mag_y field Units: G Comment: Calibrated Magnetometer reading
 java.lang.Float[] getCalibratedMagZ()
           
 java.lang.Float getCalibratedMagZ(int index)
          Get calibrated_mag_z field Units: G Comment: Calibrated Magnetometer reading
 java.lang.Integer[] getMagX()
           
 java.lang.Integer getMagX(int index)
          Get mag_x field Units: counts Comment: These are the raw ADC reading.
 java.lang.Integer[] getMagY()
           
 java.lang.Integer getMagY(int index)
          Get mag_y field Units: counts Comment: These are the raw ADC reading.
 java.lang.Integer[] getMagZ()
           
 java.lang.Integer getMagZ(int index)
          Get mag_z field Units: counts Comment: These are the raw ADC reading.
 int getNumCalibratedMagX()
           
 int getNumCalibratedMagY()
           
 int getNumCalibratedMagZ()
           
 int getNumMagX()
           
 int getNumMagY()
           
 int getNumMagZ()
           
 int getNumSampleTimeOffset()
           
 java.lang.Integer[] getSampleTimeOffset()
           
 java.lang.Integer getSampleTimeOffset(int index)
          Get sample_time_offset field Units: ms Comment: Each time in the array describes the time at which the compass sample with the corrosponding index was taken.
 DateTime getTimestamp()
          Get timestamp field Units: s Comment: Whole second part of the timestamp
 java.lang.Integer getTimestampMs()
          Get timestamp_ms field Units: ms Comment: Millisecond part of the timestamp.
 void setCalibratedMagX(int index, java.lang.Float calibratedMagX)
          Set calibrated_mag_x field Units: G Comment: Calibrated Magnetometer reading
 void setCalibratedMagY(int index, java.lang.Float calibratedMagY)
          Set calibrated_mag_y field Units: G Comment: Calibrated Magnetometer reading
 void setCalibratedMagZ(int index, java.lang.Float calibratedMagZ)
          Set calibrated_mag_z field Units: G Comment: Calibrated Magnetometer reading
 void setMagX(int index, java.lang.Integer magX)
          Set mag_x field Units: counts Comment: These are the raw ADC reading.
 void setMagY(int index, java.lang.Integer magY)
          Set mag_y field Units: counts Comment: These are the raw ADC reading.
 void setMagZ(int index, java.lang.Integer magZ)
          Set mag_z field Units: counts Comment: These are the raw ADC reading.
 void setSampleTimeOffset(int index, java.lang.Integer sampleTimeOffset)
          Set sample_time_offset field Units: ms Comment: Each time in the array describes the time at which the compass sample with the corrosponding index was taken.
 void setTimestamp(DateTime timestamp)
          Set timestamp field Units: s Comment: Whole second part of the timestamp
 void setTimestampMs(java.lang.Integer timestampMs)
          Set timestamp_ms field Units: ms Comment: Millisecond part of the timestamp.
 
Methods inherited from class com.garmin.fit.Mesg
addDeveloperField, addField, getActiveSubFieldIndex, getActiveSubFieldName, getDeveloperFields, getField, getField, getField, getFieldBigIntegerValue, getFieldBigIntegerValue, getFieldBigIntegerValue, getFieldBigIntegerValue, getFieldBigIntegerValue, getFieldBigIntegerValue, getFieldBigIntegerValues, getFieldBigIntegerValues, getFieldBigIntegerValues, getFieldBitsValue, getFieldBitsValue, getFieldByteValue, getFieldByteValue, getFieldByteValue, getFieldByteValue, getFieldByteValue, getFieldByteValue, getFieldByteValues, getFieldByteValues, getFieldByteValues, getFieldDoubleValue, getFieldDoubleValue, getFieldDoubleValue, getFieldDoubleValue, getFieldDoubleValue, getFieldDoubleValue, getFieldDoubleValues, getFieldDoubleValues, getFieldDoubleValues, getFieldFloatValue, getFieldFloatValue, getFieldFloatValue, getFieldFloatValue, getFieldFloatValue, getFieldFloatValue, getFieldFloatValues, getFieldFloatValues, getFieldFloatValues, getFieldIntegerValue, getFieldIntegerValue, getFieldIntegerValue, getFieldIntegerValue, getFieldIntegerValue, getFieldIntegerValue, getFieldIntegerValues, getFieldIntegerValues, getFieldIntegerValues, getFieldLongValue, getFieldLongValue, getFieldLongValue, getFieldLongValue, getFieldLongValue, getFieldLongValue, getFieldLongValues, getFieldLongValues, getFieldLongValues, getFields, getFieldShortValue, getFieldShortValue, getFieldShortValue, getFieldShortValue, getFieldShortValue, getFieldShortValue, getFieldShortValues, getFieldShortValues, getFieldShortValues, getFieldStringValue, getFieldStringValue, getFieldStringValue, getFieldStringValue, getFieldStringValue, getFieldStringValue, getFieldStringValues, getFieldStringValues, getFieldStringValues, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getIsFieldAccumulated, getLocalNum, getName, getNum, getNumFields, getNumFieldValues, getNumFieldValues, getNumFieldValues, getNumFieldValues, getOverrideField, hasField, removeExpandedFields, removeField, setField, setFields, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setLocalNum, timestampToDateTime, write, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TimestampFieldNum

public static final int TimestampFieldNum
See Also:
Constant Field Values

TimestampMsFieldNum

public static final int TimestampMsFieldNum
See Also:
Constant Field Values

SampleTimeOffsetFieldNum

public static final int SampleTimeOffsetFieldNum
See Also:
Constant Field Values

MagXFieldNum

public static final int MagXFieldNum
See Also:
Constant Field Values

MagYFieldNum

public static final int MagYFieldNum
See Also:
Constant Field Values

MagZFieldNum

public static final int MagZFieldNum
See Also:
Constant Field Values

CalibratedMagXFieldNum

public static final int CalibratedMagXFieldNum
See Also:
Constant Field Values

CalibratedMagYFieldNum

public static final int CalibratedMagYFieldNum
See Also:
Constant Field Values

CalibratedMagZFieldNum

public static final int CalibratedMagZFieldNum
See Also:
Constant Field Values

magnetometerDataMesg

protected static final Mesg magnetometerDataMesg
Constructor Detail

MagnetometerDataMesg

public MagnetometerDataMesg()

MagnetometerDataMesg

public MagnetometerDataMesg(Mesg mesg)
Method Detail

getTimestamp

public DateTime getTimestamp()
Get timestamp field Units: s Comment: Whole second part of the timestamp

Returns:
timestamp

setTimestamp

public void setTimestamp(DateTime timestamp)
Set timestamp field Units: s Comment: Whole second part of the timestamp

Parameters:
timestamp -

getTimestampMs

public java.lang.Integer getTimestampMs()
Get timestamp_ms field Units: ms Comment: Millisecond part of the timestamp.

Returns:
timestamp_ms

setTimestampMs

public void setTimestampMs(java.lang.Integer timestampMs)
Set timestamp_ms field Units: ms Comment: Millisecond part of the timestamp.

Parameters:
timestampMs -

getSampleTimeOffset

public java.lang.Integer[] getSampleTimeOffset()

getNumSampleTimeOffset

public int getNumSampleTimeOffset()
Returns:
number of sample_time_offset

getSampleTimeOffset

public java.lang.Integer getSampleTimeOffset(int index)
Get sample_time_offset field Units: ms Comment: Each time in the array describes the time at which the compass sample with the corrosponding index was taken. Limited to 30 samples in each message. The samples may span across seconds. Array size must match the number of samples in cmps_x and cmps_y and cmps_z

Parameters:
index - of sample_time_offset
Returns:
sample_time_offset

setSampleTimeOffset

public void setSampleTimeOffset(int index,
                                java.lang.Integer sampleTimeOffset)
Set sample_time_offset field Units: ms Comment: Each time in the array describes the time at which the compass sample with the corrosponding index was taken. Limited to 30 samples in each message. The samples may span across seconds. Array size must match the number of samples in cmps_x and cmps_y and cmps_z

Parameters:
index - of sample_time_offset
sampleTimeOffset -

getMagX

public java.lang.Integer[] getMagX()

getNumMagX

public int getNumMagX()
Returns:
number of mag_x

getMagX

public java.lang.Integer getMagX(int index)
Get mag_x field Units: counts Comment: These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Parameters:
index - of mag_x
Returns:
mag_x

setMagX

public void setMagX(int index,
                    java.lang.Integer magX)
Set mag_x field Units: counts Comment: These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Parameters:
index - of mag_x
magX -

getMagY

public java.lang.Integer[] getMagY()

getNumMagY

public int getNumMagY()
Returns:
number of mag_y

getMagY

public java.lang.Integer getMagY(int index)
Get mag_y field Units: counts Comment: These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Parameters:
index - of mag_y
Returns:
mag_y

setMagY

public void setMagY(int index,
                    java.lang.Integer magY)
Set mag_y field Units: counts Comment: These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Parameters:
index - of mag_y
magY -

getMagZ

public java.lang.Integer[] getMagZ()

getNumMagZ

public int getNumMagZ()
Returns:
number of mag_z

getMagZ

public java.lang.Integer getMagZ(int index)
Get mag_z field Units: counts Comment: These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Parameters:
index - of mag_z
Returns:
mag_z

setMagZ

public void setMagZ(int index,
                    java.lang.Integer magZ)
Set mag_z field Units: counts Comment: These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Parameters:
index - of mag_z
magZ -

getCalibratedMagX

public java.lang.Float[] getCalibratedMagX()

getNumCalibratedMagX

public int getNumCalibratedMagX()
Returns:
number of calibrated_mag_x

getCalibratedMagX

public java.lang.Float getCalibratedMagX(int index)
Get calibrated_mag_x field Units: G Comment: Calibrated Magnetometer reading

Parameters:
index - of calibrated_mag_x
Returns:
calibrated_mag_x

setCalibratedMagX

public void setCalibratedMagX(int index,
                              java.lang.Float calibratedMagX)
Set calibrated_mag_x field Units: G Comment: Calibrated Magnetometer reading

Parameters:
index - of calibrated_mag_x
calibratedMagX -

getCalibratedMagY

public java.lang.Float[] getCalibratedMagY()

getNumCalibratedMagY

public int getNumCalibratedMagY()
Returns:
number of calibrated_mag_y

getCalibratedMagY

public java.lang.Float getCalibratedMagY(int index)
Get calibrated_mag_y field Units: G Comment: Calibrated Magnetometer reading

Parameters:
index - of calibrated_mag_y
Returns:
calibrated_mag_y

setCalibratedMagY

public void setCalibratedMagY(int index,
                              java.lang.Float calibratedMagY)
Set calibrated_mag_y field Units: G Comment: Calibrated Magnetometer reading

Parameters:
index - of calibrated_mag_y
calibratedMagY -

getCalibratedMagZ

public java.lang.Float[] getCalibratedMagZ()

getNumCalibratedMagZ

public int getNumCalibratedMagZ()
Returns:
number of calibrated_mag_z

getCalibratedMagZ

public java.lang.Float getCalibratedMagZ(int index)
Get calibrated_mag_z field Units: G Comment: Calibrated Magnetometer reading

Parameters:
index - of calibrated_mag_z
Returns:
calibrated_mag_z

setCalibratedMagZ

public void setCalibratedMagZ(int index,
                              java.lang.Float calibratedMagZ)
Set calibrated_mag_z field Units: G Comment: Calibrated Magnetometer reading

Parameters:
index - of calibrated_mag_z
calibratedMagZ -