navit
0.5.3-trunk
|
A traffic message. More...
#include <traffic.h>
Data Fields | |
char * | id |
time_t | receive_time |
time_t | update_time |
time_t | expiration_time |
time_t | start_time |
time_t | end_time |
int | is_cancellation |
int | is_forecast |
int | replaced_count |
char ** | replaces |
struct traffic_location * | location |
int | event_count |
struct traffic_event ** | events |
struct traffic_message_priv * | priv |
A traffic message.
A message is the atomic element of traffic information, referring to a particular condition at a given location.
If no updates are received for a message, it should be discarded after both expiration_time
and end_time
(if specified) have elapsed.
time_t traffic_message::end_time |
How long the condition is expected to last (optional, 0 if not set).
Referenced by traffic_message_dump_to_stderr(), traffic_message_is_valid(), and traffic_message_new().
int traffic_message::event_count |
The number of events in events
.
Referenced by traffic_message_add_event(), traffic_message_destroy(), traffic_message_dump_to_stderr(), traffic_message_is_valid(), traffic_message_new(), traffic_message_new_short(), and traffic_message_parse_events().
struct traffic_event** traffic_message::events |
Points to an array of pointers to the events for this message.
Referenced by traffic_message_add_event(), traffic_message_destroy(), traffic_message_dump_to_stderr(), traffic_message_get_event(), traffic_message_is_valid(), traffic_message_new(), traffic_message_new_short(), and traffic_message_parse_events().
time_t traffic_message::expiration_time |
How long the message should be considered valid.
Referenced by traffic_message_dump_to_stderr(), traffic_message_is_valid(), traffic_message_new(), traffic_message_new_cancellation(), traffic_message_new_short(), and traffic_process_messages_int().
char* traffic_message::id |
An identifier, which remains stable over the entire lifecycle of the message. The colon (:) is a reserved character to separate different levels of source identifiers from each other and from the local message identifier.
Referenced by traffic_message_add_segments(), traffic_message_destroy(), traffic_message_dump_to_stderr(), traffic_message_is_valid(), traffic_message_new(), traffic_message_remove_item_data(), traffic_message_restore_segments(), and traffic_process_messages_int().
int traffic_message::is_cancellation |
If true, this message is a cancellation message, indicating that existing messages with the same ID should be deleted or no longer considered current. All other attributes of a cancellation message should be ignored.
Referenced by traffic_message_dump_to_stderr(), traffic_message_is_valid(), and traffic_message_new().
int traffic_message::is_forecast |
If false, the message describes a current situation. If true, it describes an expected situation in the future.
Referenced by traffic_message_dump_to_stderr(), traffic_message_new(), and traffic_message_new_short().
struct traffic_location* traffic_message::location |
The location to which this message refers.
Referenced by traffic_message_add_segments(), traffic_message_destroy(), traffic_message_dump_to_stderr(), traffic_message_is_valid(), traffic_message_new(), traffic_message_new_cancellation(), traffic_message_new_short(), traffic_message_parse_events(), traffic_message_restore_segments(), and traffic_process_messages_int().
struct traffic_message_priv* traffic_message::priv |
Internal data, not exposed via the API
Referenced by tm_rect_new(), traffic_message_add_segments(), traffic_message_destroy(), traffic_message_get_items(), traffic_message_new(), traffic_message_remove_item_data(), traffic_message_restore_segments(), and traffic_process_messages_int().
time_t traffic_message::receive_time |
When the message was first received by the source, should be kept stable across all updates.
Referenced by traffic_message_dump_to_stderr(), traffic_message_is_valid(), traffic_message_new(), traffic_message_new_cancellation(), and traffic_message_new_short().
int traffic_message::replaced_count |
The number of entries in replaces
.
Referenced by traffic_message_destroy(), traffic_message_dump_to_stderr(), and traffic_message_new().
char** traffic_message::replaces |
Points to an array of identifiers of messages which the current message replaces.
Referenced by traffic_message_destroy(), traffic_message_dump_to_stderr(), traffic_message_new(), and traffic_process_messages_int().
time_t traffic_message::start_time |
When the condition is expected to begin (optional, 0 if not set).
Referenced by traffic_message_dump_to_stderr(), and traffic_message_new().
time_t traffic_message::update_time |
When the last update to this message was received by the source.
Referenced by traffic_message_dump_to_stderr(), traffic_message_is_valid(), traffic_message_new(), traffic_message_new_cancellation(), and traffic_message_new_short().