A comprehensive set of functions for parsing and converting date and time strings. More...

Functions
template<class T = Month>
T	time_shield::get_month_number (const std::string &month)
	Get the month number by name.

template<class T = Month>
T	time_shield::month_of_year (const std::string &month)
	Alias for get_month_number function.

template<class T = Month>
bool	time_shield::try_get_month_number (const std::string &month, T &value)
	Get the month number by name, with output parameter.

template<class T = Month>
bool	time_shield::get_month_number (const std::string &month, T &value)
	Alias for try_get_month_number function.

template<class T = Month>
bool	time_shield::month_of_year (const std::string &month, T &value)
	Alias for try_get_month_number function.

bool	time_shield::parse_time_zone (const std::string &tz_str, TimeZoneStruct &tz)
	Parse a time zone string into a TimeZoneStruct.

bool	time_shield::parse_tz (const std::string &tz_str, TimeZoneStruct &tz)
	Alias for parse_time_zone function.

bool	time_shield::parse_iso8601 (const std::string &input, DateTimeStruct &dt, TimeZoneStruct &tz)
	Parse a date and time string in ISO8601 format.

bool	time_shield::str_to_ts (const std::string &str, ts_t &ts)
	Convert an ISO8601 string to a timestamp (ts_t).

bool	time_shield::str_to_ts_ms (const std::string &str, ts_ms_t &ts)
	Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

bool	time_shield::str_to_fts (const std::string &str, fts_t &ts)
	Convert an ISO8601 string to a floating-point timestamp (fts_t).

ts_t	time_shield::ts (const std::string &str)
	Convert an ISO8601 string to a timestamp (ts_t).

ts_ms_t	time_shield::ts_ms (const std::string &str)
	Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

fts_t	time_shield::fts (const std::string &str)
	Convert an ISO8601 string to a floating-point timestamp (fts_t).

template<class T = int>
bool	time_shield::sec_of_day (const std::string &str, T &sec)
	Parse time of day string to seconds of day.

template<class T = int>
T	time_shield::sec_of_day (const std::string &str)
	Convert time of day string to seconds of day.

ts_t	time_shield::ts (const char *str)
	Convert an ISO8601 C-style string to a timestamp (ts_t).

ts_ms_t	time_shield::ts_ms (const char *str)
	Convert an ISO8601 C-style string to a millisecond timestamp (ts_ms_t).

fts_t	time_shield::fts (const char *str)
	Convert an ISO8601 C-style string to a floating-point timestamp (fts_t).

int	time_shield::get_month_number (string month)
	Get the month number by name.

int	time_shield::month_of_year (string month)
	Alias for get_month_number function.

bool	time_shield::try_get_month_number (string month, int &value)
	Get the month number by name, with output parameter.

bool	time_shield::get_month_number (string month, int &value)
	Alias for try_get_month_number function.

bool	time_shield::month_of_year (string month, int &value)
	Alias for try_get_month_number function.

bool	time_shield::parse_time_zone (string tz_str, TimeZoneStruct &tz)
	Parse a time zone string into a TimeZoneStruct.

bool	time_shield::parse_tz (string tz_str, TimeZoneStruct &tz)
	Alias for parse_time_zone function.

bool	time_shield::parse_iso8601 (string input_str, DateTimeStruct &dt, TimeZoneStruct &tz)
	Parse a date and time string in ISO8601 format.

bool	time_shield::str_to_ts (string str, long &ts)
	Convert an ISO8601 string to a timestamp (ts_t).

bool	time_shield::str_to_ts_ms (string str, long &ts)
	Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

bool	time_shield::str_to_fts (string str, double &ts)
	Convert an ISO8601 string to a floating-point timestamp (fts_t).

long	time_shield::ts (string str)
	Convert an ISO8601 string to a timestamp (ts_t).

long	time_shield::ts_ms (string str)
	Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

double	time_shield::fts (string str)
	Convert an ISO8601 string to a floating-point timestamp (fts_t).

int	time_shield::sec_of_day (string str)
	Convert string with time of day to second of day.

Detailed Description

A comprehensive set of functions for parsing and converting date and time strings.

This module provides utilities for parsing date and time strings in ISO8601 format, extracting date components, and converting them into various timestamp formats.

Key Features:

Parse ISO8601 date and time strings.
Extract month numbers from month names.
Convert parsed date and time to timestamp formats (seconds, milliseconds, floating-point).

Usage Examples:

Parse an ISO8601 string and get a timestamp:
ts_t timestamp;

bool success = time_shield::str_to_ts("2024-11-25T14:30:00Z", timestamp);

time_shield::str_to_ts
bool str_to_ts(const std::string &str, ts_t &ts)
Convert an ISO8601 string to a timestamp (ts_t).
Definition time_parser.hpp:233

time_shield::ts_t
int64_t ts_t
Unix timestamp in seconds since 1970‑01‑01T00:00:00Z.
Definition types.hpp:45

time_shield::timestamp
const ts_t timestamp() noexcept
Get the current UTC timestamp in seconds.
Definition time_utils.hpp:131
Extract a month number from a string:
time_shield::Month month = time_shield::get_month_number<Month>("March");

time_shield::Month
Month
Definition enums.hpp:92

time_shield::get_month_number
T get_month_number(const std::string &month)
Get the month number by name.
Definition time_parser.hpp:64
Parse an ISO8601 string into a DateTimeStruct:
time_shield::DateTimeStruct dt;

time_shield::TimeZoneStruct tz;

bool valid = time_shield::parse_iso8601("2024-11-25T14:30:00+01:00", dt, tz);

time_shield::parse_iso8601
bool parse_iso8601(const std::string &input, DateTimeStruct &dt, TimeZoneStruct &tz)
Parse a date and time string in ISO8601 format.
Definition time_parser.hpp:188

time_shield::DateTimeStruct
Structure to represent date and time.
Definition date_time_struct.hpp:14

time_shield::TimeZoneStruct
Structure to represent time zone information.
Definition time_zone_struct.hpp:20

Function Documentation

◆ fts() [1/3]

fts_t time_shield::fts ( const char * str )

inline

Convert an ISO8601 C-style string to a floating-point timestamp (fts_t).

This function parses a string in ISO8601 format and converts it to a floating-point timestamp. If the parsing fails, it returns 0.

Parameters

str	The ISO8601 C-style string.

Returns: The floating-point timestamp if successful, 0 otherwise.

Definition at line 407 of file time_parser.hpp.

◆ fts() [2/3]

fts_t time_shield::fts ( const std::string & str )

inline

Convert an ISO8601 string to a floating-point timestamp (fts_t).

This function parses a string in ISO8601 format and converts it to a floating-point timestamp. If the parsing fails, it returns 0.

Parameters

str	The ISO8601 string.

Returns: The floating-point timestamp if successful, 0 otherwise.

Definition at line 303 of file time_parser.hpp.

◆ fts() [3/3]

double time_shield::fts ( string str )

Convert an ISO8601 string to a floating-point timestamp (fts_t).

Returns 0.0 if parsing fails.

Parameters

str	The ISO8601 string.

Returns: Floating-point timestamp or 0.0 on error.

Definition at line 232 of file time_parser.mqh.

◆ get_month_number() [1/4]

template<class T = Month>

T time_shield::get_month_number ( const std::string & month )

Get the month number by name.

Template Parameters

T	The return type, default is Month enum.

Parameters

month The name of the month as a string.

Returns: The month number corresponding to the given name.

Exceptions

std::invalid_argument if the month name is invalid.

Definition at line 64 of file time_parser.hpp.

◆ get_month_number() [2/4]

template<class T = Month>

bool time_shield::get_month_number	(	const std::string &	month,
		T &	value )

Alias for try_get_month_number function.

Get the month number by name, with output parameter.

Template Parameters

T	The type for the month number, default is Month enum.

Parameters

month	The name of the month as a string.
value	The reference to store the month number if found.

Returns: True if the month name is valid, false otherwise.

Definition at line 135 of file time_parser.hpp.

◆ get_month_number() [3/4]

int time_shield::get_month_number ( string month )

Get the month number by name.

Parameters

month The name of the month as a string.

Returns: The month number corresponding to the given name, or 0 on error.

Definition at line 39 of file time_parser.mqh.

◆ get_month_number() [4/4]

bool time_shield::get_month_number	(	string	month,
		int &	value )

Alias for try_get_month_number function.

Get the month number by name, with output parameter.

Template Parameters

T	The type for the month number, default is Month enum.

Parameters

month	The name of the month as a string.
value	The reference to store the month number if found.

Returns: True if the month name is valid, false otherwise.

Definition at line 80 of file time_parser.mqh.

◆ month_of_year() [1/4]

template<class T = Month>

T time_shield::month_of_year ( const std::string & month )

Alias for get_month_number function.

Get the month number by name.

Template Parameters

T	The return type, default is Month enum.

Parameters

month The name of the month as a string.

Returns: The month number corresponding to the given name.

Exceptions

std::invalid_argument if the month name is invalid.

Definition at line 93 of file time_parser.hpp.

◆ month_of_year() [2/4]

template<class T = Month>

bool time_shield::month_of_year	(	const std::string &	month,
		T &	value )

Alias for try_get_month_number function.

Get the month number by name, with output parameter.

Template Parameters

T	The type for the month number, default is Month enum.

Parameters

month	The name of the month as a string.
value	The reference to store the month number if found.

Returns: True if the month name is valid, false otherwise.

Definition at line 142 of file time_parser.hpp.

◆ month_of_year() [3/4]

int time_shield::month_of_year ( string month )

Alias for get_month_number function.

Get the month number by name.

Template Parameters

T	The return type, default is Month enum.

Parameters

month The name of the month as a string.

Returns: The month number corresponding to the given name.

Exceptions

std::invalid_argument if the month name is invalid.

Definition at line 62 of file time_parser.mqh.

◆ month_of_year() [4/4]

bool time_shield::month_of_year	(	string	month,
		int &	value )

Alias for try_get_month_number function.

Get the month number by name, with output parameter.

Template Parameters

T	The type for the month number, default is Month enum.

Parameters

month	The name of the month as a string.
value	The reference to store the month number if found.

Returns: True if the month name is valid, false otherwise.

Definition at line 84 of file time_parser.mqh.

◆ parse_iso8601() [1/2]

bool time_shield::parse_iso8601	(	const std::string &	input,
		DateTimeStruct &	dt,
		TimeZoneStruct &	tz )

Parse a date and time string in ISO8601 format.

This function parses a date and time string in the ISO8601 format and fills the provided DateTimeStruct and TimeZoneStruct with the parsed values.

Parameters

input	The input string in ISO8601 format.
dt	The DateTimeStruct to be filled with the parsed date and time values.
tz	The TimeZoneStruct to be filled with the parsed time zone values.

Returns: True if the parsing is successful and the date and time values are valid, false otherwise.

Definition at line 188 of file time_parser.hpp.

◆ parse_iso8601() [2/2]

bool time_shield::parse_iso8601	(	string	input_str,
		DateTimeStruct &	dt,
		TimeZoneStruct &	tz )

Parse a date and time string in ISO8601 format.

Parameters

input_str	The input string in ISO8601 format.
dt	The DateTimeStruct to be filled with parsed values.
tz	The TimeZoneStruct to be filled with parsed time zone.

Returns: True if parsing succeeds and the date and time values are valid, false otherwise.

Definition at line 117 of file time_parser.mqh.

◆ parse_time_zone() [1/2]

bool time_shield::parse_time_zone	(	const std::string &	tz_str,
		TimeZoneStruct &	tz )

Parse a time zone string into a TimeZoneStruct.

This function parses a time zone string in the format "+hh:mm" or "Z" into a TimeZoneStruct. If the string is empty or "Z", it sets the time zone to UTC.

Parameters

tz_str	The time zone string.
tz	The TimeZoneStruct to be filled.

Returns: True if the parsing is successful and the time zone is valid, false otherwise.

Definition at line 154 of file time_parser.hpp.

◆ parse_time_zone() [2/2]

bool time_shield::parse_time_zone	(	string	tz_str,
		TimeZoneStruct &	tz )

Parse a time zone string into a TimeZoneStruct.

Parses a time zone string in the format "+hh:mm", "-hh:mm" or "Z". If the string is empty or "Z", UTC is assumed.

Parameters

tz_str	The time zone string.
tz	The TimeZoneStruct to be filled.

Returns: True if the parsing is successful and the time zone is valid, false otherwise.

Definition at line 94 of file time_parser.mqh.

◆ parse_tz() [1/2]

bool time_shield::parse_tz	(	const std::string &	tz_str,
		TimeZoneStruct &	tz )

inline

Alias for parse_time_zone function.

Parse a time zone string into a TimeZoneStruct.

This function parses a time zone string in the format "+hh:mm" or "Z" into a TimeZoneStruct. If the string is empty or "Z", it sets the time zone to UTC.

Parameters

tz_str	The time zone string.
tz	The TimeZoneStruct to be filled.

Returns: True if the parsing is successful and the time zone is valid, false otherwise.

Definition at line 175 of file time_parser.hpp.

◆ parse_tz() [2/2]

bool time_shield::parse_tz	(	string	tz_str,
		TimeZoneStruct &	tz )

Alias for parse_time_zone function.

Parse a time zone string into a TimeZoneStruct.

This function parses a time zone string in the format "+hh:mm" or "Z" into a TimeZoneStruct. If the string is empty or "Z", it sets the time zone to UTC.

Parameters

tz_str	The time zone string.
tz	The TimeZoneStruct to be filled.

Returns: True if the parsing is successful and the time zone is valid, false otherwise.

Definition at line 108 of file time_parser.mqh.

◆ sec_of_day() [1/3]

template<class T = int>

T time_shield::sec_of_day ( const std::string & str )

inline

Convert time of day string to seconds of day.

Supported formats:

HH:MM:SS
HH:MM
HH

Template Parameters

T	Return type (default int).

Parameters

str	Time of day as string.

Returns: Parsed seconds of day or SEC_PER_DAY if parsing fails.

Definition at line 372 of file time_parser.hpp.

◆ sec_of_day() [2/3]

template<class T = int>

bool time_shield::sec_of_day	(	const std::string &	str,
		T &	sec )

inline

Parse time of day string to seconds of day.

Supported formats:

HH:MM:SS
HH:MM
HH

Template Parameters

T	Return type (default int).

Parameters

str	Time of day as string.
sec	Parsed seconds of day on success.

Returns: True on successful parsing.

Definition at line 323 of file time_parser.hpp.

◆ sec_of_day() [3/3]

int time_shield::sec_of_day ( string str )

Convert string with time of day to second of day.

Supports formats:

HH:MM:SS
HH:MM
HH
Parameters

str Time in string format

Returns
Second of the day if conversion succeeded, or SEC_PER_DAY if it failed.

Definition at line 248 of file time_parser.mqh.

◆ str_to_fts() [1/2]

bool time_shield::str_to_fts	(	const std::string &	str,
		fts_t &	ts )

inline

Convert an ISO8601 string to a floating-point timestamp (fts_t).

This function parses a string in ISO8601 format and converts it to a floating-point timestamp.

Parameters

str	The ISO8601 string.
ts	The floating-point timestamp to be filled.

Returns: True if the parsing and conversion are successful, false otherwise.

Definition at line 265 of file time_parser.hpp.

◆ str_to_fts() [2/2]

bool time_shield::str_to_fts	(	string	str,
		double &	ts )

Convert an ISO8601 string to a floating-point timestamp (fts_t).

Parameters

str	The ISO8601 string.
ts	The floating-point timestamp to be filled.

Returns: True if the parsing and conversion are successful, false otherwise.

Definition at line 201 of file time_parser.mqh.

◆ str_to_ts() [1/2]

bool time_shield::str_to_ts	(	const std::string &	str,
		ts_t &	ts )

inline

Convert an ISO8601 string to a timestamp (ts_t).

This function parses a string in ISO8601 format and converts it to a timestamp.

Parameters

str	The ISO8601 string.
ts	The timestamp to be filled.

Returns: True if the parsing and conversion are successful, false otherwise.

Definition at line 233 of file time_parser.hpp.

◆ str_to_ts() [2/2]

bool time_shield::str_to_ts	(	string	str,
		long &	ts )

Convert an ISO8601 string to a timestamp (ts_t).

Parameters

str	The ISO8601 string.
ts	The timestamp to be filled.

Returns: True if the parsing and conversion are successful, false otherwise.

Definition at line 179 of file time_parser.mqh.

◆ str_to_ts_ms() [1/2]

bool time_shield::str_to_ts_ms	(	const std::string &	str,
		ts_ms_t &	ts )

inline

Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

This function parses a string in ISO8601 format and converts it to a millisecond timestamp.

Parameters

str	The ISO8601 string.
ts	The millisecond timestamp to be filled.

Returns: True if the parsing and conversion are successful, false otherwise.

Definition at line 249 of file time_parser.hpp.

◆ str_to_ts_ms() [2/2]

bool time_shield::str_to_ts_ms	(	string	str,
		long &	ts )

Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

Parameters

str	The ISO8601 string.
ts	The millisecond timestamp to be filled.

Returns: True if the parsing and conversion are successful, false otherwise.

Definition at line 190 of file time_parser.mqh.

◆ try_get_month_number() [1/2]

template<class T = Month>

bool time_shield::try_get_month_number	(	const std::string &	month,
		T &	value )

Get the month number by name, with output parameter.

Template Parameters

T	The type for the month number, default is Month enum.

Parameters

month	The name of the month as a string.
value	The reference to store the month number if found.

Returns: True if the month name is valid, false otherwise.

Definition at line 105 of file time_parser.hpp.

◆ try_get_month_number() [2/2]

bool time_shield::try_get_month_number	(	string	month,
		int &	value )

Get the month number by name, with output parameter.

Parameters

month	The name of the month as a string.
value	Reference to store the month number if found.

Returns: True if the month name is valid, false otherwise.

Definition at line 70 of file time_parser.mqh.

◆ ts() [1/3]

ts_t time_shield::ts ( const char * str )

inline

Convert an ISO8601 C-style string to a timestamp (ts_t).

This function parses a string in ISO8601 format and converts it to a timestamp. If parsing fails, it returns 0.

Parameters

str	The ISO8601 C-style string.

Returns: The timestamp value. Returns 0 if parsing fails.

Definition at line 385 of file time_parser.hpp.

◆ ts() [2/3]

ts_t time_shield::ts ( const std::string & str )

inline

Convert an ISO8601 string to a timestamp (ts_t).

This function parses a string in ISO8601 format and converts it to a timestamp. If parsing fails, it returns 0.

Parameters

str	The ISO8601 string.

Returns: The timestamp value. Returns 0 if parsing fails.

Definition at line 281 of file time_parser.hpp.

◆ ts() [3/3]

long time_shield::ts ( string str )

Convert an ISO8601 string to a timestamp (ts_t).

Returns 0 if parsing fails.

Parameters

str	The ISO8601 string.

Returns: Timestamp value or 0 on error.

Definition at line 212 of file time_parser.mqh.

◆ ts_ms() [1/3]

ts_ms_t time_shield::ts_ms ( const char * str )

inline

Convert an ISO8601 C-style string to a millisecond timestamp (ts_ms_t).

This function parses a string in ISO8601 format and converts it to a millisecond timestamp. If parsing fails, it returns 0.

Parameters

str	The ISO8601 C-style string.

Returns: The parsed millisecond timestamp, or 0 if parsing fails.

Definition at line 396 of file time_parser.hpp.

◆ ts_ms() [2/3]

ts_ms_t time_shield::ts_ms ( const std::string & str )

inline

Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

This function parses a string in ISO8601 format and converts it to a millisecond timestamp. If parsing fails, it returns 0.

Parameters

str	The ISO8601 string.

Returns: The parsed millisecond timestamp, or 0 if parsing fails.

Definition at line 292 of file time_parser.hpp.

◆ ts_ms() [3/3]

long time_shield::ts_ms ( string str )

Convert an ISO8601 string to a millisecond timestamp (ts_ms_t).

Returns 0 if parsing fails.

Parameters

str	The ISO8601 string.

Returns: Millisecond timestamp value or 0 on error.

Definition at line 222 of file time_parser.mqh.

Functions

Detailed Description

Key Features:

Usage Examples:

Function Documentation

◆ fts() [1/3]

◆ fts() [2/3]

◆ fts() [3/3]

◆ get_month_number() [1/4]

◆ get_month_number() [2/4]

◆ get_month_number() [3/4]

◆ get_month_number() [4/4]

◆ month_of_year() [1/4]

◆ month_of_year() [2/4]

◆ month_of_year() [3/4]

◆ month_of_year() [4/4]

◆ parse_iso8601() [1/2]

◆ parse_iso8601() [2/2]

◆ parse_time_zone() [1/2]

◆ parse_time_zone() [2/2]

◆ parse_tz() [1/2]

◆ parse_tz() [2/2]

◆ sec_of_day() [1/3]

◆ sec_of_day() [2/3]

◆ sec_of_day() [3/3]

◆ str_to_fts() [1/2]

◆ str_to_fts() [2/2]

◆ str_to_ts() [1/2]

◆ str_to_ts() [2/2]

◆ str_to_ts_ms() [1/2]

◆ str_to_ts_ms() [2/2]

◆ try_get_month_number() [1/2]

◆ try_get_month_number() [2/2]

◆ ts() [1/3]

◆ ts() [2/3]

◆ ts() [3/3]

◆ ts_ms() [1/3]

◆ ts_ms() [2/3]

◆ ts_ms() [3/3]