ocpn Namespace Reference

Standard, mostly strings utilities. More...

Functions
wxString	toUsrDateTimeFormat (const wxDateTime date_time, const DateTimeFormatOptions &options)
bool	endswith (const std::string &s, const std::string &suffix)
	Return true if s ends with given suffix.
bool	startswith (const std::string &s, const std::string &prefix)
	Return true if s starts with given prefix.
std::vector< std::string >	split (const char *s, const std::string &delimiter)
	Return vector of items in s separated by delimiter.
std::vector< std::string >	split (const std::string &s, const std::string &delimiter)
	Return vector of items in s separated by delimiter.
bool	exists (const std::string &name)
void	mkdir (const std::string path)
std::string	ltrim (const std::string &s)
	Strip possibly leading space characters in s.
std::string	rtrim (const std::string &s)
	Strip possibly trailing space characters in s.
std::string	trim (std::string s)
	Strip possibly trailing and/or leading space characters in s.
std::string	join (std::vector< std::string > v, char c)
	Return a single string being the concatenation of all elements in v with character c in between.
std::string	tolower (const std::string &s)
	Return copy of s with all characters converted to lower case.
bool	replace (std::string &str, const std::string &from, const std::string &to)
	Perform in place substitution in str, replacing "from" with "to".
void	copy_file (const std::string &src_path, const std::string &dest_path)
	Copy file contents in path src_path to dest_path.
bool	N0183CheckSumOk (const std::string &sentence)
	Check if checksum in a NMEA0183 sentence is correct.
std::string	printable (const std::string &str)
	Return copy of str with non-printable chars replaced by hex like "<0D>".
std::string	get_basename (const char *path)
bool	store_metadata (const char *path)
	Store metadata in metadata cache, return success/fail.
std::string	lookup_metadata (const char *name=0)
	Get metadata path for a given name defaulting to ocpn-plugins.xml)
bool	store_tarball (const char *path, const char *basename)
	Store a tarball in tarball cache, return success/fail.
std::string	lookup_tarball (const char *basename)
	Get path to tarball in cache for given filename.
unsigned	cache_file_count ()
	Return number of files in cache.
unsigned long	cache_size ()
	Return total size of files in cache in kbytes.
void	cache_clear ()
	Remove all files in cache:
wxString	toUsrDateTimeFormat (const wxDateTime date_time, const ::DateTimeFormatOptions &options=::DateTimeFormatOptions())
	Format a date/time to a localized string representation, conforming to the formatting options.

Detailed Description

Standard, mostly strings utilities.

Function Documentation

cache_clear()

void ocpn::cache_clear

(

)

Remove all files in cache:

Definition at line 163 of file plugin_cache.cpp.

cache_file_count()

unsigned ocpn::cache_file_count

(

)

Return number of files in cache.

Definition at line 115 of file plugin_cache.cpp.

cache_size()

unsigned long ocpn::cache_size

(

)

Return total size of files in cache in kbytes.

Definition at line 132 of file plugin_cache.cpp.

copy_file()

void ocpn::copy_file	(	const std::string &	src_path,
		const std::string &	dest_path
	)

Copy file contents in path src_path to dest_path.

Definition at line 143 of file ocpn_utils.cpp.

endswith()

bool ocpn::endswith	(	const std::string &	str,
		const std::string &	suffix
	)

Return true if s ends with given suffix.

Definition at line 45 of file ocpn_utils.cpp.

exists()

bool ocpn::exists

(

const std::string &

path

)

Deprecated:

Using std::filesystem instead.

Definition at line 75 of file ocpn_utils.cpp.

get_basename()

std::string ocpn::get_basename

(

const char *

path

)

Definition at line 68 of file plugin_cache.cpp.

join()

std::string ocpn::join	(	std::vector< std::string >	v,
		char	c
	)

Return a single string being the concatenation of all elements in v with character c in between.

Definition at line 119 of file ocpn_utils.cpp.

lookup_metadata()

std::string ocpn::lookup_metadata

(

const char *

name = 0

)

Get metadata path for a given name defaulting to ocpn-plugins.xml)

Returns

Path to cached metadata or "" if not found

Definition at line 93 of file plugin_cache.cpp.

lookup_tarball()

std::string ocpn::lookup_tarball

(

const char *

basename

)

Get path to tarball in cache for given filename.

Returns

Path to cached metadata or "" if not found

Definition at line 109 of file plugin_cache.cpp.

ltrim()

std::string ocpn::ltrim

(

const std::string &

s

)

Strip possibly leading space characters in s.

Returns

new string with leading non-printable characters removed

Definition at line 94 of file ocpn_utils.cpp.

mkdir()

void ocpn::mkdir

(

const std::string

path

)

Deprecated:

Using std::filesystem instead.

Deprecated:

Using std::filesystem instead.

Definition at line 84 of file ocpn_utils.cpp.

N0183CheckSumOk()

bool ocpn::N0183CheckSumOk

(

const std::string &

sentence

)

Check if checksum in a NMEA0183 sentence is correct.

Parameters

sentence

complete NMEA01832 message

Returns

true if checksum is OK, else false.

Definition at line 153 of file ocpn_utils.cpp.

printable()

std::string ocpn::printable

(

const std::string &

str

)

Return copy of str with non-printable chars replaced by hex like "<0D>".

Definition at line 170 of file ocpn_utils.cpp.

replace()

bool ocpn::replace	(	std::string &	str,
		const std::string &	from,
		const std::string &	to
	)

Perform in place substitution in str, replacing "from" with "to".

Returns

true if any replacement is done.

Definition at line 136 of file ocpn_utils.cpp.

rtrim()

std::string ocpn::rtrim

(

const std::string &

s

)

Strip possibly trailing space characters in s.

Returns

string with trailing non-printable characters removed

Definition at line 103 of file ocpn_utils.cpp.

split() [1/2]

std::vector< std::string > ocpn::split	(	const char *	token_string,
		const std::string &	delimiter
	)

Return vector of items in s separated by delimiter.

Definition at line 55 of file ocpn_utils.cpp.

split() [2/2]

std::vector< std::string > ocpn::split	(	const std::string &	string,
		const std::string &	delimiter
	)

Return vector of items in s separated by delimiter.

Definition at line 70 of file ocpn_utils.cpp.

startswith()

bool ocpn::startswith	(	const std::string &	str,
		const std::string &	prefix
	)

Return true if s starts with given prefix.

Definition at line 50 of file ocpn_utils.cpp.

store_metadata()

bool ocpn::store_metadata

(

const char *

path

)

Store metadata in metadata cache, return success/fail.

Definition at line 84 of file plugin_cache.cpp.

store_tarball()

bool ocpn::store_tarball	(	const char *	path,
		const char *	basename
	)

Store a tarball in tarball cache, return success/fail.

Definition at line 101 of file plugin_cache.cpp.

tolower()

std::string ocpn::tolower

(

const std::string &

input

)

Return copy of s with all characters converted to lower case.

Definition at line 130 of file ocpn_utils.cpp.

toUsrDateTimeFormat() [1/2]

wxString ocpn::toUsrDateTimeFormat	(	const wxDateTime	date_time,
		const ::DateTimeFormatOptions &	options = ::DateTimeFormatOptions()
	)

Format a date/time to a localized string representation, conforming to the formatting options.

Parameters

date_time	The date/time to format.
options	The date/time format options.

Returns

wxString The formatted date/time string.

Note

This function should be used instead of wxDateTime.Format() to ensure consistent date/time formatting across the entire application, including plugins.

toUsrDateTimeFormat() [2/2]

wxString ocpn::toUsrDateTimeFormat	(	const wxDateTime	date_time,
		const DateTimeFormatOptions &	options
	)

Definition at line 31 of file datetime.cpp.

trim()

std::string ocpn::trim

(

std::string

s

)

Strip possibly trailing and/or leading space characters in s.

Returns

string with trailing and leading non-printable characters removed

Definition at line 113 of file ocpn_utils.cpp.