com.smartdevicelink.proxy.rpc

Class RdsData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.RdsData

All Implemented Interfaces:

Cloneable

public class RdsData
extends RPCStruct

Include the data defined in Radio Data System, which is a communications protocol standard for embedding small amounts of digital information in conventional FM radio broadcasts.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CT
static String	KEY_PI
static String	KEY_PS
static String	KEY_PTY
static String	KEY_REG
static String	KEY_RT
static String	KEY_TA
static String	KEY_TP

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
RdsData()
RdsData(Hashtable<String,Object> hash)

Method Summary

Modifier and Type	Method and Description
String	getClockText() Gets the clockText portion of the RdsData class
String	getProgramIdentification() Gets the programIdentification portion of the RdsData class
String	getProgramService() Gets the programService portion of the RdsData class
Integer	getProgramType() Gets the programType portion of the RdsData class
String	getRadioText() Gets the radioText portion of the RdsData class
String	getRegion() Gets the region portion of the RdsData class
Boolean	getTrafficAnnouncement() Gets the trafficAnnouncement portion of the RdsData class
Boolean	getTrafficProgram() Gets the trafficProgram portion of the RdsData class
RdsData	setClockText(String clockText) Sets the clockText portion of the RdsData class
RdsData	setProgramIdentification(String programIdentification) Sets the programIdentification portion of the RdsData class
RdsData	setProgramService(String programService) Sets the programService portion of the RdsData class
RdsData	setProgramType(Integer programType) Sets the programType portion of the RdsData class
RdsData	setRadioText(String radioText) Sets the radioText portion of the RdsData class
RdsData	setRegion(String region) Sets the region portion of the RdsData class
RdsData	setTrafficAnnouncement(Boolean trafficAnnouncement) Sets the trafficAnnouncement portion of the RdsData class
RdsData	setTrafficProgram(Boolean trafficProgram) Sets the trafficProgram portion of the RdsData class

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, 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_PS

public static final String KEY_PS

See Also:

Constant Field Values

KEY_RT

public static final String KEY_RT

See Also:

Constant Field Values

KEY_CT

public static final String KEY_CT

See Also:

Constant Field Values

KEY_PI

public static final String KEY_PI

See Also:

Constant Field Values

KEY_PTY

public static final String KEY_PTY

See Also:

Constant Field Values

KEY_TP

public static final String KEY_TP

See Also:

Constant Field Values

KEY_TA

public static final String KEY_TA

See Also:

Constant Field Values

KEY_REG

public static final String KEY_REG

See Also:

Constant Field Values

Constructor Detail

RdsData

public RdsData()

RdsData

public RdsData(Hashtable<String,Object> hash)

Method Detail

setProgramService

public RdsData setProgramService(String programService)

Sets the programService portion of the RdsData class

Parameters:

programService - Program Service Name.

getProgramService

public String getProgramService()

Gets the programService portion of the RdsData class

Returns:

String - Program Service Name.

setRadioText

public RdsData setRadioText(String radioText)

Sets the radioText portion of the RdsData class

Parameters:

radioText - Radio Text.

getRadioText

public String getRadioText()

Gets the radioText portion of the RdsData class

Returns:

String - Radio Text.

setClockText

public RdsData setClockText(String clockText)

Sets the clockText portion of the RdsData class

Parameters:

clockText - The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD.

getClockText

public String getClockText()

Gets the clockText portion of the RdsData class

Returns:

String - The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD.

setProgramIdentification

public RdsData setProgramIdentification(String programIdentification)

Sets the programIdentification portion of the RdsData class

Parameters:

programIdentification - Program Identification - the call sign for the radio station.

getProgramIdentification

public String getProgramIdentification()

Gets the programIdentification portion of the RdsData class

Returns:

String - Program Identification - the call sign for the radio station.

setRegion

public RdsData setRegion(String region)

Sets the region portion of the RdsData class

Parameters:

region - Region.

getRegion

public String getRegion()

Gets the region portion of the RdsData class

Returns:

String - Region.

setTrafficProgram

public RdsData setTrafficProgram(Boolean trafficProgram)

Sets the trafficProgram portion of the RdsData class

Parameters:

trafficProgram - Traffic Program Identification - Identifies a station that offers traffic.

getTrafficProgram

public Boolean getTrafficProgram()

Gets the trafficProgram portion of the RdsData class

Returns:

Boolean - Traffic Program Identification - Identifies a station that offers traffic.

setTrafficAnnouncement

public RdsData setTrafficAnnouncement(Boolean trafficAnnouncement)

Sets the trafficAnnouncement portion of the RdsData class

Parameters:

trafficAnnouncement - Traffic Announcement Identification - Indicates an ongoing traffic announcement.

getTrafficAnnouncement

public Boolean getTrafficAnnouncement()

Gets the trafficAnnouncement portion of the RdsData class

Returns:

Boolean - Traffic Announcement Identification - Indicates an ongoing traffic announcement.

setProgramType

public RdsData setProgramType(Integer programType)

Sets the programType portion of the RdsData class

Parameters:

programType - The program type - The region should be used to differentiate between EU and North America program types.

getProgramType

public Integer getProgramType()

Gets the programType portion of the RdsData class

Returns:

Integer - The program type. The region should be used to differentiate between EU and North America program types.