OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
DateTimeFormatOptions Struct Reference

Configuration options for date and time formatting. More...

#include <ocpn_plugin.h>

Public Member Functions

DateTimeFormatOptions & SetFormatString (const wxString &fmt)
 Sets the date/time format pattern string.
 
DateTimeFormatOptions & SetTimezone (const wxString &tz)
 Sets the timezone mode for date/time display.
 
DateTimeFormatOptions & SetLongitude (double lon)
 Sets the reference longitude for Local Mean Time (LMT) calculations.
 

Public Attributes

wxString format_string = "$weekday_short_date_time"
 The format string for date/time.
 
wxString time_zone = wxEmptyString
 The timezone to use when formatting the date/time.
 
double longitude = NAN
 The longitude to use when formatting the date/time in Local Mean Time (LMT).
 
int version = 1
 

Detailed Description

Configuration options for date and time formatting.

This structure holds formatting options that determine how dates and times are displayed throughout the application. It allows configuring format strings, timezone settings, and geographic reference for local time calculations.

The format settings use standard date/time format specifiers (like strftime) for creating custom date/time representations based on user preferences. Timezone settings allow displaying times in UTC, system local time, or a custom zone based on the vessel's current position.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 2862 of file ocpn_plugin.h.

Member Function Documentation

◆ SetFormatString()

DateTimeFormatOptions & DateTimeFormatOptions::SetFormatString ( const wxString &  fmt)
inline

Sets the date/time format pattern string.

Parameters
formatString containing date/time format specifiers.

This method configures the format pattern used when displaying dates and times. The following predefined format strings are supported:

  • "$long_date": Thursday December 31, 2021.
  • "$short_date": 12/31/2021.
  • "$weekday_short_date": Thu 12/31/2021.
  • "$hour_minutes_seconds": 15:34:56 zero-padded.
  • "$hour_minutes": 15:34 zero-padded.
  • "$long_date_time": Thursday December 31, 2021 12:34:56.
  • "$short_date_time": 12/31/2021 15:34:56.
  • "$weekday_short_date_time": Thu 12/31/2021 15:34:56.

The default is $weekday_short_date_time.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 2926 of file ocpn_plugin.h.

◆ SetLongitude()

DateTimeFormatOptions & DateTimeFormatOptions::SetLongitude ( double  lon)
inline

Sets the reference longitude for Local Mean Time (LMT) calculations.

Parameters
lonLongitude in decimal degrees (-180 to +180)

When timezone mode is set to local time at vessel position, this method provides the longitude used to calculate the Local Mean Time (LMT).

LMT is calculated based on the sun's position relative to the local meridian, with solar noon occurring when the sun crosses the meridian. Each 15 degrees of longitude represents approximately 1 hour of time difference.

Unlike standard timezone offsets which use fixed boundaries, LMT provides a continuous time representation based precisely on the vessel's longitude, useful for celestial navigation and traditional maritime timekeeping.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 2971 of file ocpn_plugin.h.

◆ SetTimezone()

DateTimeFormatOptions & DateTimeFormatOptions::SetTimezone ( const wxString &  tz)
inline

Sets the timezone mode for date/time display.

Parameters
timezoneSpecifies the timezone mode:
  • Empty string (default): the date/time is formatted according to the OpenCPN global settings. This should be used to ensure consistency of the date/time representation across the entire application.
  • "UTC": the date/time is formatted in UTC, regardless of the OpenCPN global settings.
  • "Local Time": the date/time is formatted in the local time, regardless of the OpenCPN global settings.

This method configures how time values are adjusted for timezone display.

  • When set to empty or UTC, all times are shown in universal time without adjustment.
  • When set to "Local Time", times are adjusted to match the timezone settings of the computer running OpenCPN.
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 2949 of file ocpn_plugin.h.

Member Data Documentation

◆ format_string

wxString DateTimeFormatOptions::format_string = "$weekday_short_date_time"

The format string for date/time.

The following predefined format strings are supported:

  • "$long_date": Thursday December 31, 2021.
  • "$short_date": 12/31/2021.
  • "$weekday_short_date": Thu 12/31/2021.
  • "$hour_minutes_seconds": 15:34:56 zero-padded.
  • "$hour_minutes": 15:34 zero-padded.
  • "$long_date_time": Thursday December 31, 2021 12:34:56.
  • "$short_date_time": 12/31/2021 15:34:56.
  • "$weekday_short_date_time": Thu 12/31/2021 15:34:56.

The default is $weekday_short_date_time.

The descriptors are resolved to localized date/time string representations. For example, $short_date is resolved to "12/31/2021" in the US locale and "31/12/2021" in the UK locale.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 2883 of file ocpn_plugin.h.

◆ longitude

double DateTimeFormatOptions::longitude = NAN

The longitude to use when formatting the date/time in Local Mean Time (LMT).

The longitude is required when the time_zone is set to "LMT".

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 2904 of file ocpn_plugin.h.

◆ time_zone

wxString DateTimeFormatOptions::time_zone = wxEmptyString

The timezone to use when formatting the date/time.

Supported options are:

  • Empty string (default): the date/time is formatted according to the OpenCPN global settings. This should be used to ensure consistency of the date/time representation across the entire application.
  • "UTC": the date/time is formatted in UTC, regardless of the OpenCPN global settings.
  • "Local Time": the date/time is formatted in the local time, regardless of the OpenCPN global settings.
Note
In the future, additional timezone options may be supported:
  • "LMT": the date/time is formatted in local mean time. In this case, longitude is required.
  • Valid timezone name: the date/time is formatted in that timezone.
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 2899 of file ocpn_plugin.h.

◆ version

int DateTimeFormatOptions::version = 1

Definition at line 2906 of file ocpn_plugin.h.

The documentation for this struct was generated from the following file: