ObdiiDataMessage Class Reference

The ObdiiDataMessage class represents a FIT ObdiiDataMessage data message. More...

Inheritance diagram for ObdiiDataMessage:

Collaboration diagram for ObdiiDataMessage:

Public Member Functions
	ObdiiDataMessage ()
	Constructs a ObdiiDataMessage object. More...
DateTime	timestamp () const
	Returns the ObdiiDataMessage data message's timestamp field's current value. More...
quint16	timestampMs () const
	Returns the ObdiiDataMessage data message's timestampMs field's current value. More...
quint16	timeOffset () const
	Returns the ObdiiDataMessage data message's timeOffset field's current value. More...
quint8	pid () const
	Returns the ObdiiDataMessage data message's pid field's current value. More...
quint8	rawData () const
	Returns the ObdiiDataMessage data message's rawData field's current value. More...
quint8	pidDataSize () const
	Returns the ObdiiDataMessage data message's pidDataSize field's current value. More...
quint32	systemTime () const
	Returns the ObdiiDataMessage data message's systemTime field's current value. More...
DateTime	startTimestamp () const
	Returns the ObdiiDataMessage data message's startTimestamp field's current value. More...
quint16	startTimestampMs () const
	Returns the ObdiiDataMessage data message's startTimestampMs field's current value. More...
void	setTimestamp (const DateTime timestamp)
	Sets the timestamp field to timestamp. More...
void	setTimestampMs (const quint16 timestampMs)
	Sets the timestampMs field to timestampMs. More...
void	setTimeOffset (const quint16 timeOffset)
	Sets the timeOffset field to timeOffset. More...
void	setPid (const quint8 pid)
	Sets the pid field to pid. More...
void	setRawData (const quint8 rawData)
	Sets the rawData field to rawData. More...
void	setPidDataSize (const quint8 pidDataSize)
	Sets the pidDataSize field to pidDataSize. More...
void	setSystemTime (const quint32 systemTime)
	Sets the systemTime field to systemTime. More...
void	setStartTimestamp (const DateTime startTimestamp)
	Sets the startTimestamp field to startTimestamp. More...
void	setStartTimestampMs (const quint16 startTimestampMs)
	Sets the startTimestampMs field to startTimestampMs. More...
Public Member Functions inherited from AbstractDataMessage
	~AbstractDataMessage ()
	Destroys the AbstractDataMessage object.
MesgNum	globalMessageNumber () const
	Returns the data message's global message number. More...

Additional Inherited Members
Static Public Member Functions inherited from AbstractDataMessage
static AbstractDataMessage *	fromData (const DataDefinition *const defn, const QByteArray &record)
	Constructs the relevant AbstractDataMessage-derived class to parse record according to defn. More...

Detailed Description

The ObdiiDataMessage class represents a FIT ObdiiDataMessage data message.

See also

DataMessage

Constructor & Destructor Documentation

ObdiiDataMessage()

ObdiiDataMessage::ObdiiDataMessage

(

)

Constructs a ObdiiDataMessage object.

Typically, instances of this class will be returned by FitStreamReader::readNext, but this constructor may be used, along with the relevant setter methods, to create a valid message.

Member Function Documentation

pid()

quint8 ObdiiDataMessage::pid

(

)

const

Returns the ObdiiDataMessage data message's pid field's current value.

Parameter ID

Returns

the pid field value.

Here is the caller graph for this function:

pidDataSize()

quint8 ObdiiDataMessage::pidDataSize

(

)

const

Returns the ObdiiDataMessage data message's pidDataSize field's current value.

Optional, data size of PID[i]. If not specified refer to SAE J1979.

Returns

the pidDataSize field value.

Here is the caller graph for this function:

rawData()

quint8 ObdiiDataMessage::rawData

(

)

const

Returns the ObdiiDataMessage data message's rawData field's current value.

Raw parameter data

Returns

the rawData field value.

Here is the caller graph for this function:

setPid()

void ObdiiDataMessage::setPid

(

const quint8

pid

)

Sets the pid field to pid.

Parameters

pid	The field value to set.

Here is the call graph for this function:

setPidDataSize()

void ObdiiDataMessage::setPidDataSize

(

const quint8

pidDataSize

)

Sets the pidDataSize field to pidDataSize.

Parameters

pidDataSize

The field value to set.

Here is the call graph for this function:

setRawData()

void ObdiiDataMessage::setRawData

(

const quint8

rawData

)

Sets the rawData field to rawData.

Parameters

rawData

The field value to set.

Here is the call graph for this function:

setStartTimestamp()

void ObdiiDataMessage::setStartTimestamp

(

const DateTime

startTimestamp

)

Sets the startTimestamp field to startTimestamp.

Parameters

startTimestamp

The field value to set.

Here is the call graph for this function:

setStartTimestampMs()

void ObdiiDataMessage::setStartTimestampMs

(

const quint16

startTimestampMs

)

Sets the startTimestampMs field to startTimestampMs.

Parameters

startTimestampMs

The field value to set.

Here is the call graph for this function:

setSystemTime()

void ObdiiDataMessage::setSystemTime

(

const quint32

systemTime

)

Sets the systemTime field to systemTime.

Parameters

systemTime

The field value to set.

Here is the call graph for this function:

setTimeOffset()

void ObdiiDataMessage::setTimeOffset

(

const quint16

timeOffset

)

Sets the timeOffset field to timeOffset.

Parameters

timeOffset

The field value to set.

Here is the call graph for this function:

setTimestamp()

void ObdiiDataMessage::setTimestamp

(

const DateTime

timestamp

)

Sets the timestamp field to timestamp.

Parameters

timestamp

The field value to set.

Here is the call graph for this function:

setTimestampMs()

void ObdiiDataMessage::setTimestampMs

(

const quint16

timestampMs

)

Sets the timestampMs field to timestampMs.

Parameters

timestampMs

The field value to set.

Here is the call graph for this function:

startTimestamp()

DateTime ObdiiDataMessage::startTimestamp

(

)

const

Returns the ObdiiDataMessage data message's startTimestamp field's current value.

Timestamp of first sample recorded in the message. Used with time_offset to generate time of each sample

Returns

the startTimestamp field value.

Here is the caller graph for this function:

startTimestampMs()

quint16 ObdiiDataMessage::startTimestampMs

(

)

const

Returns the ObdiiDataMessage data message's startTimestampMs field's current value.

Fractional part of start_timestamp

Returns

the startTimestampMs field value.

Here is the caller graph for this function:

systemTime()

quint32 ObdiiDataMessage::systemTime

(

)

const

Returns the ObdiiDataMessage data message's systemTime field's current value.

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.

Returns

the systemTime field value.

Here is the caller graph for this function:

timeOffset()

quint16 ObdiiDataMessage::timeOffset

(

)

const

Returns the ObdiiDataMessage data message's timeOffset field's current value.

Offset of PID reading [i] from start_timestamp+start_timestamp_ms. Readings may span accross seconds.

Returns

the timeOffset field value.

Here is the caller graph for this function:

timestamp()

DateTime ObdiiDataMessage::timestamp

(

)

const

Returns the ObdiiDataMessage data message's timestamp field's current value.

Timestamp message was output

Returns

the timestamp field value.

Here is the caller graph for this function:

timestampMs()

quint16 ObdiiDataMessage::timestampMs

(

)

const

Returns the ObdiiDataMessage data message's timestampMs field's current value.

Fractional part of timestamp, added to timestamp

Returns

the timestampMs field value.

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• obdiidatamessage.h
• obdiidatamessage.cpp