dunedaq::conffwk::Version Class Reference

Represents configuration version. More...

#include <ConfigVersion.hpp>

Public Types
enum	QueryType { query_by_date , query_by_id , query_by_tag }

Public Member Functions
	Version (const std::string &id, const std::string &user, std::time_t ts, const std::string &comment, const std::vector< std::string > &files) noexcept
const std::string &	get_id () const noexcept
const std::string &	get_user () const noexcept
std::time_t	get_timestamp () const noexcept
const std::string &	get_comment () const noexcept
const std::vector< std::string > &	get_files () const noexcept

Private Attributes
std::string	m_id
std::string	m_user
std::time_t	m_timestamp
std::string	m_comment
std::vector< std::string >	m_files

Friends
class	Configuration
class	ConfigurationImpl

Detailed Description

Represents configuration version.

The objects are created by the Configuration::get_versions() and Configuration::get_changes() methods.

Definition at line 25 of file ConfigVersion.hpp.

Member Enumeration Documentation

QueryType

enum dunedaq::conffwk::Version::QueryType

Enumerator
query_by_date
query_by_id
query_by_tag

Definition at line 33 of file ConfigVersion.hpp.

      {
        query_by_date, query_by_id, query_by_tag
      };

Constructor & Destructor Documentation

Version()

dunedaq::conffwk::Version::Version ( const std::string & id, const std::string & user, std::time_t ts, const std::string & comment, const std::vector< std::string > & files )

inlinenoexcept

Definition at line 39 of file ConfigVersion.hpp.

                                                                                                                                              :
          m_id(id), m_user(user), m_timestamp(ts), m_comment(comment), m_files(files)
      {
        ;
      }

Member Function Documentation

get_comment()

const std::string & dunedaq::conffwk::Version::get_comment ( ) const

inlinenoexcept

The commit comment.

Returns

user comment

Definition at line 82 of file ConfigVersion.hpp.

      {
        return m_comment;
      }

get_files()

const std::vector< std::string > & dunedaq::conffwk::Version::get_files ( ) const

inlinenoexcept

The files modified in this version.

Returns

the modified files

Definition at line 92 of file ConfigVersion.hpp.

      {
        return m_files;
      }

get_id()

const std::string & dunedaq::conffwk::Version::get_id ( ) const

inlinenoexcept

The version unique ID is a repository hash (GIT SHA).

Returns

version unique ID

Definition at line 52 of file ConfigVersion.hpp.

      {
        return m_id;
      }

get_timestamp()

std::time_t dunedaq::conffwk::Version::get_timestamp ( ) const

inlinenoexcept

The timestamp (in seconds since Epoch) when commit was made.

Returns

timestamp

Definition at line 72 of file ConfigVersion.hpp.

      {
        return m_timestamp;
      }

get_user()

const std::string & dunedaq::conffwk::Version::get_user ( ) const

inlinenoexcept

The user who made a commit.

Returns

user name

Definition at line 62 of file ConfigVersion.hpp.

      {
        return m_user;
      }

Friends And Related Symbol Documentation

Configuration

friend class Configuration

friend

Definition at line 28 of file ConfigVersion.hpp.

ConfigurationImpl

friend class ConfigurationImpl

friend

Definition at line 29 of file ConfigVersion.hpp.

Member Data Documentation

m_comment

std::string dunedaq::conffwk::Version::m_comment

private

Definition at line 102 of file ConfigVersion.hpp.

m_files

std::vector<std::string> dunedaq::conffwk::Version::m_files

private

Definition at line 103 of file ConfigVersion.hpp.

m_id

std::string dunedaq::conffwk::Version::m_id

private

Definition at line 99 of file ConfigVersion.hpp.

m_timestamp

std::time_t dunedaq::conffwk::Version::m_timestamp

private

Definition at line 101 of file ConfigVersion.hpp.

m_user

std::string dunedaq::conffwk::Version::m_user

private

Definition at line 100 of file ConfigVersion.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/conffwk/include/conffwk/ConfigVersion.hpp