com.smartdevicelink.proxy.rpc

Class DiagnosticMessage

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.DiagnosticMessage

All Implemented Interfaces:

Cloneable

public class DiagnosticMessage
extends RPCRequest

Non periodic vehicle diagnostic request.

Parameter List

Name	Type	Description	Reg.	Notes	Version
targetID	Integer	Name of target ECU.	Y	Min Value: 0; Max Value: 65535	SmartDeviceLink 3.0
messageLength	Integer	Length of message (in bytes).	Y	Min Value: 0; Max Value:65535	SmartDeviceLink 3.0
messageData	Integer	Array of bytes comprising CAN message.	Y	Min Value: 0; Max Value:255; Min Size:1; Max Size:65535	SmartDeviceLink 3.0

HMI must:

1. Check the requested data using provided information of targetID (name of ECU),messageLength and messageData.

2. Respond with one of the appropriate result codes.And in case of SUCCESS return messageDataResult which is an array of bytes comprising CAN message result.

Since:

SmartDeviceLink 3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MESSAGE_DATA
static String	KEY_MESSAGE_LENGTH
static String	KEY_TARGET_ID

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
DiagnosticMessage() Constructs a new DiagnosticMessage object
DiagnosticMessage(Hashtable<String,Object> hash) Constructs a new DiagnosticMessage object indicated by the Hashtable parameter
DiagnosticMessage(Integer targetID, Integer messageLength, List<Integer> messageData) Constructs a new DiagnosticMessage object

Method Summary

Modifier and Type	Method and Description
List<Integer>	getMessageData()
Integer	getMessageLength()
Integer	getTargetID() Returns an Integer object representing the Target ID that you want to add
DiagnosticMessage	setMessageData(List<Integer> messageData)
DiagnosticMessage	setMessageLength(Integer messageLength)
DiagnosticMessage	setTargetID(Integer targetID) Sets TargetID

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

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

Field Detail

KEY_TARGET_ID

public static final String KEY_TARGET_ID

See Also:

Constant Field Values

KEY_MESSAGE_LENGTH

public static final String KEY_MESSAGE_LENGTH

See Also:

Constant Field Values

KEY_MESSAGE_DATA

public static final String KEY_MESSAGE_DATA

See Also:

Constant Field Values

Constructor Detail

DiagnosticMessage

public DiagnosticMessage()

Constructs a new DiagnosticMessage object

DiagnosticMessage

public DiagnosticMessage(Hashtable<String,Object> hash)

Constructs a new DiagnosticMessage object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use to create this RPC

DiagnosticMessage

public DiagnosticMessage(@NonNull
                         Integer targetID,
                         @NonNull
                         Integer messageLength,
                         @NonNull
                         List<Integer> messageData)

Constructs a new DiagnosticMessage object

Method Detail

setTargetID

public DiagnosticMessage setTargetID(@NonNull
                                     Integer targetID)

Sets TargetID

Parameters:

targetID - the target for this Diagnostic Message

getTargetID

public Integer getTargetID()

Returns an Integer object representing the Target ID that you want to add

Returns:

Integer -an integer representation a Unique Target ID

setMessageLength

public DiagnosticMessage setMessageLength(@NonNull
                                          Integer messageLength)

getMessageLength

public Integer getMessageLength()

getMessageData

public List<Integer> getMessageData()

setMessageData

public DiagnosticMessage setMessageData(@NonNull
                                        List<Integer> messageData)