oks::tz::DB Class Reference

#include <tz.hpp>

Public Member Functions
	DB ()
boost::local_time::time_zone_ptr	get_tz_ptr (const std::string &region)
	Get boost time-zone pointer from string.
std::vector< std::string >	get_regions ()
	Get known time zone regions.

Private Attributes
boost::local_time::tz_database	m_tz_db

Detailed Description

The class provides access to Boost time-zone database. It relies on Boost time-zone database file installed by oksutils package and pointed by BOOST_DATE_TIME_TZ_SPEC process environment variable.

Definition at line 26 of file tz.hpp.

Constructor & Destructor Documentation

DB()

oks::tz::DB::DB

(

)

Find and read Boost time-zone database.

Definition at line 21 of file oks_tz.cpp.

{
  const char* tz_spec_file = ::getenv("BOOST_DATE_TIME_TZ_SPEC");
 
  if (!tz_spec_file || !*tz_spec_file) {
    throw std::runtime_error("cannot read value of BOOST_DATE_TIME_TZ_SPEC environment variable");
  }
 
  TLOG_DEBUG(1) << "Boost time-zone specification file is \'" << tz_spec_file << '\'';
 
  try {
    m_tz_db.load_from_file(tz_spec_file);
  } catch (const std::exception& ex) {
    std::ostringstream text;
    text << "cannot read Boost time-zone specification file \"" << tz_spec_file << "\": " << ex.what();
    throw std::runtime_error(text.str().c_str());
  }
}

Member Function Documentation

get_regions()

std::vector< std::string > oks::tz::DB::get_regions

(

)

Get known time zone regions.

This is a helper function for several utilities dealing with Boost time-zone database.

Returns

vector of known regions

Exceptions

std::exception

if something goes wrong

Definition at line 55 of file oks_tz.cpp.

{
  return m_tz_db.region_list();
}

get_tz_ptr()

boost::local_time::time_zone_ptr oks::tz::DB::get_tz_ptr

(

const std::string &

region

)

Get boost time-zone pointer from string.

This is a helper method for several utilities dealing with Boost time-zone database.

Parameters

region

name of time zone

Returns

time-zone boost pointer

Exceptions

std::exception

if something goes wrong

Definition at line 41 of file oks_tz.cpp.

{
  boost::local_time::time_zone_ptr tz_ptr = m_tz_db.time_zone_from_region(region);
 
  if (!tz_ptr) {
    std::ostringstream text;
    text << "cannot find time-zone \'" << region << '\'';
    throw std::runtime_error(text.str().c_str());
  }
 
  return tz_ptr;
}

Member Data Documentation

m_tz_db

boost::local_time::tz_database oks::tz::DB::m_tz_db

private

Definition at line 56 of file tz.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/dunedaq/sourcecode/oksutils/include/oksutils/oks/tz.hpp
• /github/workspace/dunedaq/sourcecode/oksutils/src/lib/oks_tz.cpp