com.garmin.fit
Class ObdiiDataMesg

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

public class ObdiiDataMesg
extends Mesg


Field Summary
protected static Mesg obdiiDataMesg
           
static int PidDataSizeFieldNum
           
static int PidFieldNum
           
static int RawDataFieldNum
           
static int StartTimestampFieldNum
           
static int StartTimestampMsFieldNum
           
static int SystemTimeFieldNum
           
static int TimeOffsetFieldNum
           
static int TimestampFieldNum
           
static int TimestampMsFieldNum
           
 
Fields inherited from class com.garmin.fit.Mesg
developerFields, fields, localNum, name, num, systemTimeOffset
 
Constructor Summary
ObdiiDataMesg()
           
ObdiiDataMesg(Mesg mesg)
           
 
Method Summary
 int getNumPidDataSize()
           
 int getNumRawData()
           
 int getNumSystemTime()
           
 int getNumTimeOffset()
           
 java.lang.Byte getPid()
          Get pid field Comment: Parameter ID
 java.lang.Short[] getPidDataSize()
           
 java.lang.Short getPidDataSize(int index)
          Get pid_data_size field Comment: Optional, data size of PID[i].
 java.lang.Byte[] getRawData()
           
 java.lang.Byte getRawData(int index)
          Get raw_data field Comment: Raw parameter data
 DateTime getStartTimestamp()
          Get start_timestamp field Comment: Timestamp of first sample recorded in the message.
 java.lang.Integer getStartTimestampMs()
          Get start_timestamp_ms field Units: ms Comment: Fractional part of start_timestamp
 java.lang.Long[] getSystemTime()
           
 java.lang.Long getSystemTime(int index)
          Get system_time field Comment: System time associated with sample expressed in ms, can be used instead of time_offset.
 java.lang.Integer[] getTimeOffset()
           
 java.lang.Integer getTimeOffset(int index)
          Get time_offset field Units: ms Comment: Offset of PID reading [i] from start_timestamp+start_timestamp_ms.
 DateTime getTimestamp()
          Get timestamp field Units: s Comment: Timestamp message was output
 java.lang.Integer getTimestampMs()
          Get timestamp_ms field Units: ms Comment: Fractional part of timestamp, added to timestamp
 void setPid(java.lang.Byte pid)
          Set pid field Comment: Parameter ID
 void setPidDataSize(int index, java.lang.Short pidDataSize)
          Set pid_data_size field Comment: Optional, data size of PID[i].
 void setRawData(int index, java.lang.Byte rawData)
          Set raw_data field Comment: Raw parameter data
 void setStartTimestamp(DateTime startTimestamp)
          Set start_timestamp field Comment: Timestamp of first sample recorded in the message.
 void setStartTimestampMs(java.lang.Integer startTimestampMs)
          Set start_timestamp_ms field Units: ms Comment: Fractional part of start_timestamp
 void setSystemTime(int index, java.lang.Long systemTime)
          Set system_time field Comment: System time associated with sample expressed in ms, can be used instead of time_offset.
 void setTimeOffset(int index, java.lang.Integer timeOffset)
          Set time_offset field Units: ms Comment: Offset of PID reading [i] from start_timestamp+start_timestamp_ms.
 void setTimestamp(DateTime timestamp)
          Set timestamp field Units: s Comment: Timestamp message was output
 void setTimestampMs(java.lang.Integer timestampMs)
          Set timestamp_ms field Units: ms Comment: Fractional part of timestamp, added to 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

TimeOffsetFieldNum

public static final int TimeOffsetFieldNum
See Also:
Constant Field Values

PidFieldNum

public static final int PidFieldNum
See Also:
Constant Field Values

RawDataFieldNum

public static final int RawDataFieldNum
See Also:
Constant Field Values

PidDataSizeFieldNum

public static final int PidDataSizeFieldNum
See Also:
Constant Field Values

SystemTimeFieldNum

public static final int SystemTimeFieldNum
See Also:
Constant Field Values

StartTimestampFieldNum

public static final int StartTimestampFieldNum
See Also:
Constant Field Values

StartTimestampMsFieldNum

public static final int StartTimestampMsFieldNum
See Also:
Constant Field Values

obdiiDataMesg

protected static final Mesg obdiiDataMesg
Constructor Detail

ObdiiDataMesg

public ObdiiDataMesg()

ObdiiDataMesg

public ObdiiDataMesg(Mesg mesg)
Method Detail

getTimestamp

public DateTime getTimestamp()
Get timestamp field Units: s Comment: Timestamp message was output

Returns:
timestamp

setTimestamp

public void setTimestamp(DateTime timestamp)
Set timestamp field Units: s Comment: Timestamp message was output

Parameters:
timestamp -

getTimestampMs

public java.lang.Integer getTimestampMs()
Get timestamp_ms field Units: ms Comment: Fractional part of timestamp, added to timestamp

Returns:
timestamp_ms

setTimestampMs

public void setTimestampMs(java.lang.Integer timestampMs)
Set timestamp_ms field Units: ms Comment: Fractional part of timestamp, added to timestamp

Parameters:
timestampMs -

getTimeOffset

public java.lang.Integer[] getTimeOffset()

getNumTimeOffset

public int getNumTimeOffset()
Returns:
number of time_offset

getTimeOffset

public java.lang.Integer getTimeOffset(int index)
Get time_offset field Units: ms Comment: Offset of PID reading [i] from start_timestamp+start_timestamp_ms. Readings may span accross seconds.

Parameters:
index - of time_offset
Returns:
time_offset

setTimeOffset

public void setTimeOffset(int index,
                          java.lang.Integer timeOffset)
Set time_offset field Units: ms Comment: Offset of PID reading [i] from start_timestamp+start_timestamp_ms. Readings may span accross seconds.

Parameters:
index - of time_offset
timeOffset -

getPid

public java.lang.Byte getPid()
Get pid field Comment: Parameter ID

Returns:
pid

setPid

public void setPid(java.lang.Byte pid)
Set pid field Comment: Parameter ID

Parameters:
pid -

getRawData

public java.lang.Byte[] getRawData()

getNumRawData

public int getNumRawData()
Returns:
number of raw_data

getRawData

public java.lang.Byte getRawData(int index)
Get raw_data field Comment: Raw parameter data

Parameters:
index - of raw_data
Returns:
raw_data

setRawData

public void setRawData(int index,
                       java.lang.Byte rawData)
Set raw_data field Comment: Raw parameter data

Parameters:
index - of raw_data
rawData -

getPidDataSize

public java.lang.Short[] getPidDataSize()

getNumPidDataSize

public int getNumPidDataSize()
Returns:
number of pid_data_size

getPidDataSize

public java.lang.Short getPidDataSize(int index)
Get pid_data_size field Comment: Optional, data size of PID[i]. If not specified refer to SAE J1979.

Parameters:
index - of pid_data_size
Returns:
pid_data_size

setPidDataSize

public void setPidDataSize(int index,
                           java.lang.Short pidDataSize)
Set pid_data_size field Comment: Optional, data size of PID[i]. If not specified refer to SAE J1979.

Parameters:
index - of pid_data_size
pidDataSize -

getSystemTime

public java.lang.Long[] getSystemTime()

getNumSystemTime

public int getNumSystemTime()
Returns:
number of system_time

getSystemTime

public java.lang.Long getSystemTime(int index)
Get system_time field Comment: System time associated with sample expressed in ms, can be used instead of time_offset. There will be a system_time value for each raw_data element. For multibyte pids the system_time is repeated.

Parameters:
index - of system_time
Returns:
system_time

setSystemTime

public void setSystemTime(int index,
                          java.lang.Long systemTime)
Set system_time field Comment: System time associated with sample expressed in ms, can be used instead of time_offset. There will be a system_time value for each raw_data element. For multibyte pids the system_time is repeated.

Parameters:
index - of system_time
systemTime -

getStartTimestamp

public DateTime getStartTimestamp()
Get start_timestamp field Comment: Timestamp of first sample recorded in the message. Used with time_offset to generate time of each sample

Returns:
start_timestamp

setStartTimestamp

public void setStartTimestamp(DateTime startTimestamp)
Set start_timestamp field Comment: Timestamp of first sample recorded in the message. Used with time_offset to generate time of each sample

Parameters:
startTimestamp -

getStartTimestampMs

public java.lang.Integer getStartTimestampMs()
Get start_timestamp_ms field Units: ms Comment: Fractional part of start_timestamp

Returns:
start_timestamp_ms

setStartTimestampMs

public void setStartTimestampMs(java.lang.Integer startTimestampMs)
Set start_timestamp_ms field Units: ms Comment: Fractional part of start_timestamp

Parameters:
startTimestampMs -