TmcEvent Class Reference

TMCEvent class defines a single public static int TMC event on a location. More...

Classes
class	EventCode
	List of the possible Event codes. More...

Public Member Functions
	TmcEvent ()
	Creates the instance of the TmcEvent class with default values. More...
	TmcEvent (int id, int x, int y, int eventCode, boolean userAvoid, int validityYear, byte validityMonth, byte validityDay, byte validityHour, byte validityMinute)
	Instantiates a new tmc event. More...
int	getId ()
	Gets the id. More...
int	getX ()
	Gets the x. More...
int	getY ()
	Gets the y. More...
int	getEventCode ()
	Gets the event code. More...
boolean	isUserAvoid ()
	Checks if is user avoid. More...
int	getValidityYear ()
	Gets the validity year. More...
byte	getValidityMonth ()
	Gets the validity month. More...
byte	getValidityDay ()
	Gets the validity day. More...
byte	getValidityHour ()
	Gets the validity hour. More...
byte	getValidityMinute ()
	Gets the validity minute. More...
String	toString ()

Static Public Member Functions
static Bundle	writeBundle (TmcEvent event)
static TmcEvent	readBundle (Bundle b)

Detailed Description

TMCEvent class defines a single public static int TMC event on a location.

Constructor & Destructor Documentation

TmcEvent

(

)

Creates the instance of the TmcEvent class with default values.

Referenced by TmcEvent.readBundle().

TmcEvent	(	int	id,
		int	x,
		int	y,
		int	eventCode,
		boolean	userAvoid,
		int	validityYear,
		byte	validityMonth,
		byte	validityDay,
		byte	validityHour,
		byte	validityMinute
	)

Instantiates a new tmc event.

Parameters

id	the id
x	the x
y	the y
eventCode	the event code
userAvoid	the user avoid
validityYear	the validity year
validityMonth	the validity month
validityDay	the validity day
validityHour	the validity hour
validityMinute	the validity minute

Member Function Documentation

int getEventCode

(

)

Gets the event code.

Returns

Code of the TMC event from the EventCode enumeration

Referenced by TmcEvent.writeBundle().

int getId

(

)

Gets the id.

Returns

The ID number that was assigned to this event by applicaiton. The ID can be later used to delete the event.

Referenced by TmcEvent.writeBundle().

byte getValidityDay

(

)

Gets the validity day.

Returns

Day. Validity time, till which the event remains active. After this time is the event deleted. The events are not stored after application exit.

byte getValidityHour

(

)

Gets the validity hour.

Returns

Hour. Validity time, till which the event remains active. After this time is the event deleted. The events are not stored after application exit.

byte getValidityMinute

(

)

Gets the validity minute.

Returns

Minute. Validity time, till which the event remains active. After this time is the event deleted. The events are not stored after application exit.

byte getValidityMonth

(

)

Gets the validity month.

Returns

Month. Validity time, till which the event remains active. After this time is the event deleted. The events are not stored after application exit.

int getValidityYear

(

)

Gets the validity year.

Returns

Year. Validity time, till which the event remains active. After this time is the event deleted. The events are not stored after application exit.

Referenced by TmcEvent.writeBundle().

int getX

(

)

Gets the x.

Returns

Geographical longitude (X coordinate) of the event in world degrees multiplied by 100 000.

Referenced by TmcEvent.writeBundle().

int getY

(

)

Gets the y.

Returns

Geographical latitude (Y coordinate) of the event in world degrees multiplied by 100 000.

Referenced by TmcEvent.writeBundle().

boolean isUserAvoid

(

)

Checks if is user avoid.

Returns

if the route computing should always avoid this event.

Referenced by TmcEvent.writeBundle().

static TmcEvent readBundle ( Bundle  b )

static

References TmcEvent.TmcEvent().

Referenced by ApiOnline.addTMCEvent().

String toString

(

)

static Bundle writeBundle ( TmcEvent  event )

static

References TmcEvent.getEventCode(), TmcEvent.getId(), TmcEvent.getValidityYear(), TmcEvent.getX(), TmcEvent.getY(), and TmcEvent.isUserAvoid().

Referenced by ApiOnline.addTMCEvent().