fhicl::ParameterSetID Class Reference

#include "ParameterSetID.h"

Public Member Functions
	ParameterSetID () noexcept
	ParameterSetID (ParameterSet const &)
	ParameterSetID (std::string const &id)
bool	is_valid () const noexcept
std::string	to_string () const
void	invalidate () noexcept
void	reset (ParameterSet const &)
void	swap (ParameterSetID &)
bool	operator== (ParameterSetID const &) const noexcept
bool	operator!= (ParameterSetID const &) const noexcept
bool	operator< (ParameterSetID const &) const noexcept
bool	operator> (ParameterSetID const &) const noexcept
bool	operator<= (ParameterSetID const &) const noexcept
bool	operator>= (ParameterSetID const &) const noexcept

Static Public Member Functions
static constexpr std::size_t	max_str_size () noexcept

Private Attributes
bool	valid_
cet::sha1::digest_t	id_

Detailed Description

Definition at line 23 of file ParameterSetID.h.

Constructor & Destructor Documentation

ParameterSetID::ParameterSetID ( )

noexcept

Definition at line 23 of file ParameterSetID.cc.

References invalid_id.

: valid_{false}, id_{invalid_id} {}

ParameterSetID::ParameterSetID ( ParameterSet const &  ps )

explicit

Definition at line 25 of file ParameterSetID.cc.

References id_, and reset().

                                                     : valid_{false}, id_{}
{
  reset(ps);
}

ParameterSetID::ParameterSetID ( std::string const &  id )

explicit

Definition at line 30 of file ParameterSetID.cc.

References fhicl::cant_happen, e, util::empty(), id_, invalid_id, max_str_size(), fhicl::parse_error, to_string(), and valid_.

  : valid_{id.size() == max_str_size()}, id_{}
{
  if (valid_) {
    for (size_t i = 0, e = id_.size(); i != e; ++i) {
      id_[i] = std::stoi(id.substr(i * 2, 2), nullptr, 16);
    }
    if (id != to_string()) {
      throw exception{error::cant_happen}
        << "ParameterSetID construction failure: " << id
        << " != " << to_string() << ".\n";
    }
  } else if (id.empty()) {
    id_ = invalid_id;
  } else {
    throw fhicl::exception{error::parse_error}
      << "Attempt to construct ParameterSetID from inappropriate input: " << id
      << ".\n";
  }
}

Member Function Documentation

void ParameterSetID::invalidate ( )

noexcept

Definition at line 75 of file ParameterSetID.cc.

References id_, invalid_id, and valid_.

{
  valid_ = false;
  id_ = invalid_id;
}

bool ParameterSetID::is_valid ( ) const

noexcept

Definition at line 54 of file ParameterSetID.cc.

References valid_.

{
  return valid_;
}

constexpr std::size_t fhicl::ParameterSetID::max_str_size ( )

inlinestaticnoexcept

Definition at line 55 of file ParameterSetID.h.

Referenced by ParameterSetID(), fhicl::dbid_parser::parse(), and fhicl::ParameterSet::stringify_().

{
  // Two hex digits per byte.
  return 2 * cet::sha1::digest_sz;
}

bool ParameterSetID::operator!= ( ParameterSetID const &  other ) const

noexcept

Definition at line 107 of file ParameterSetID.cc.

References id_, and fhicl::other.

{
  return id_ != other.id_;
}

bool ParameterSetID::operator< ( ParameterSetID const &  other ) const

noexcept

Definition at line 113 of file ParameterSetID.cc.

References id_, and fhicl::other.

{
  return id_ < other.id_;
}

bool ParameterSetID::operator<= ( ParameterSetID const &  other ) const

noexcept

Definition at line 125 of file ParameterSetID.cc.

References id_, and fhicl::other.

{
  return id_ <= other.id_;
}

bool ParameterSetID::operator== ( ParameterSetID const &  other ) const

noexcept

Definition at line 101 of file ParameterSetID.cc.

References id_, and fhicl::other.

{
  return id_ == other.id_;
}

bool ParameterSetID::operator> ( ParameterSetID const &  other ) const

noexcept

Definition at line 119 of file ParameterSetID.cc.

References id_, and fhicl::other.

{
  return id_ > other.id_;
}

bool ParameterSetID::operator>= ( ParameterSetID const &  other ) const

noexcept

Definition at line 131 of file ParameterSetID.cc.

References id_, and fhicl::other.

{
  return id_ >= other.id_;
}

void ParameterSetID::reset

(

ParameterSet const &

ps

)

Definition at line 82 of file ParameterSetID.cc.

References id_, fhicl::ParameterSet::to_string(), and valid_.

Referenced by fhicl::ParameterSet::id(), and ParameterSetID().

{
  auto const hash = ps.to_string();
  sha1 sha{hash.c_str()};

  id_ = sha.digest();
  valid_ = true;
}

void ParameterSetID::swap

(

ParameterSetID &

other

)

Definition at line 92 of file ParameterSetID.cc.

References id_, std::swap(), and valid_.

{
  id_.swap(other.id_);
  std::swap(valid_, other.valid_);
}

string ParameterSetID::to_string

(

)

const

Definition at line 60 of file ParameterSetID.cc.

References id_.

Referenced by fhicl::decompose_parameterset(), fhicl::operator<<(), and ParameterSetID().

{
  std::ostringstream oss;
  oss << std::hex << std::setfill('0');
  // The range-for loop performs an implicit cast from 'unsigned char'
  // to 'unsigned int'.
  for (unsigned int const num : id_) {
    oss << std::setw(2) << num;
  }
  return oss.str();
}

Member Data Documentation

cet::sha1::digest_t fhicl::ParameterSetID::id_

private

Definition at line 50 of file ParameterSetID.h.

Referenced by invalidate(), operator!=(), operator<(), operator<=(), operator==(), operator>(), operator>=(), ParameterSetID(), reset(), swap(), and to_string().

bool fhicl::ParameterSetID::valid_

private

Definition at line 49 of file ParameterSetID.h.

Referenced by invalidate(), is_valid(), ParameterSetID(), reset(), and swap().

---

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

• fhiclcpp/ParameterSetID.h
• fhiclcpp/ParameterSetID.cc