IdDictDictionary Class Reference

#include <IdDictDictionary.h>

Collaboration diagram for IdDictDictionary:

Public Types
using	value_type = Identifier::value_type
using	size_type = Identifier::size_type

Public Member Functions
	IdDictDictionary ()
	IdDictDictionary (const std::string &name, const std::string &version="", const std::string &date="", const std::string &author="")
	~IdDictDictionary ()
const std::string &	name () const
	Dictionary name. More...
const std::string &	version () const
	Dictionary version. More...
size_t	n_regions () const
	Number of contained regions. More...
const IdDictRegion &	region (size_t i) const
	Region at index i. More...
const std::string &	file_name () const
	Access to file name. More...
const std::string &	dict_tag () const
	Access to the dictionary tag. More...
const IdDictField *	find_field (const std::string &name) const
IdDictField *	find_field (const std::string &name)
const IdDictLabel *	find_label (const std::string &field, const std::string &label) const
int	get_label_value (const std::string &field, const std::string &label, int &value) const
IdDictSubRegion *	find_subregion (const std::string &subregion_name)
const IdDictRegion *	find_region (const std::string &region_name) const
IdDictRegion *	find_region (const std::string &region_name, const std::string &group_name)
const IdDictRegion *	find_region (const std::string &region_name, const std::string &group_name) const
IdDictGroup *	find_group (const std::string &group_name)
const IdDictGroup *	find_group (const std::string &group_name) const
int	find_region (const ExpandedIdentifier &id, size_type &index) const
const IdDictRegion *	find_region (const ExpandedIdentifier &id) const
const IdDictRegion *	find_region (const ExpandedIdentifier &id, const std::string &group_name) const
const std::vector< IdDictRegion * > &	all_regions ()
	Non-const access to vector of all regions. More...
IdDictField *	add_field (std::unique_ptr< IdDictField > field)
IdDictSubRegion *	add_subregion (std::unique_ptr< IdDictSubRegion > subregion)
void	add_dictentry (std::unique_ptr< IdDictDictEntry > entry)
void	add_region (IdDictRegion *region)
void	add_subdictionary_name (const std::string &name)
void	set_parent_dict (IdDictDictionary *parent_dict)
void	set_file_name (const std::string &name)
	Set file name. More...
void	set_dict_tag (const std::string &tag)
	Set the dictionary tag. More...
void	resolve_references (IdDictMgr &idd)
void	generate_implementation (const IdDictMgr &idd, const std::string &tag="")
void	reset_implementation ()
bool	verify () const
	Here, we verify global constraints : (this must only be applied after the resolve_references and generate_implementation operations) More...
void	sort ()
	Sort: More...
void	clear ()
void	integrate_bits ()
	Set up integral of bits for efficient unpacking. More...
MultiRange	build_multirange () const
	Get MultiRange for full dictionary. More...
MultiRange	build_multirange (const ExpandedIdentifier &region_id, const Range &prefix=Range(), const std::string &last_field="") const
	Get MultiRange for a specific region_id up to and including 'last_field' If last_field == "", all fields are taken. More...
MultiRange	build_multirange (const ExpandedIdentifier &region_id, const std::string &group_name, const Range &prefix=Range(), const std::string &last_field="") const
	Get MultiRange for a specific region_id, constrained to be within a specific named group. More...
int	pack32 (const ExpandedIdentifier &id, size_t index1, size_t index2, Identifier &packedId) const
	Pack to 32bits the subset of id between (inclusive) index1 and index2 - this is generic, i.e. More...
int	pack32 (const int *fields, size_t index1, size_t index2, size_t region_index, Identifier &packedId, size_t first_field_index=0) const
	Pack to 32bits the subset of id between (inclusive) index1 and index2. More...
int	reset (size_t index1, size_t index2, size_t region_index, Identifier &packedId) const
	Reset fields from index1 to index2. More...
int	unpack (const std::string &group, const Identifier &id, const ExpandedIdentifier &prefix, size_t index2, ExpandedIdentifier &unpackedId) const
	Unpack the value_type id to an expanded Identifier for a given group, considering the provided prefix (result will include the prefix) and up to index2 - (index1 is assumed to be 0, i.e. More...
int	unpack (const std::string &group, const Identifier &id, const ExpandedIdentifier &prefix, size_t index2, const std::string &sep, std::string &unpackedId) const
	Unpack the value_type id to a string for a given group, considering the provided prefix (result will include the prefix) and up to index2 - (index1 is assumed to be 0, i.e. More...
int	unpack (const Identifier &id, size_t first_field_index, size_t field_index, size_t region_index, int &field) const
	Unpack a single field of the value_type id. More...
int	copy (const Identifier &idin, size_t first_field_index, size_t begin_field_index, size_t end_field_index, size_t region_index, Identifier &idout) const
	Copy a number of fields of the value_type id into another value_type id. More...
bool	do_checks () const
	Checks are performed by default in debug compilation and NOT in optimized compilation. More...
void	set_do_checks (bool do_checks)
bool	do_neighbours () const
	Neighbour initialization is performed by default One can switch or query this mode for any idHelper with the following methods: More...
void	set_do_neighbours (bool do_neighbours)
void	dump () const
	Dump regions and trees for each group. More...

Private Types
using	entries_type = std::vector< IdDictDictEntry * >
using	entries_it = entries_type::iterator
using	entries_const_it = entries_type::const_iterator
using	regions_type = std::vector< IdDictRegion * >
using	regions_it = regions_type::iterator
using	regions_const_it = regions_type::const_iterator
using	groups_type = std::vector< IdDictGroup * >
using	groups_it = groups_type::iterator
using	groups_const_it = groups_type::const_iterator

Private Attributes
std::string	m_name {}
std::string	m_version {}
std::string	m_date {}
std::string	m_author {}
std::map< std::string, std::unique_ptr< IdDictField > >	m_fields
std::map< std::string, std::unique_ptr< IdDictSubRegion > >	m_subregions
std::vector< IdDictRegion * >	m_regions
std::vector< IdDictRegion * >	m_all_regions
std::vector< std::unique_ptr< IdDictGroup > >	m_groups
std::vector< std::string >	m_subdictionary_names
IdDictDictionary *	m_parent_dict {nullptr}
std::string	m_file_name {}
std::string	m_dict_tag {}
bool	m_generated_implementation {false}
bool	m_do_checks {false}
bool	m_do_neighbours {true}

Detailed Description

Definition at line 31 of file IdDictDictionary.h.

Member Typedef Documentation

entries_const_it

using IdDictDictionary::entries_const_it = entries_type::const_iterator

private

Definition at line 304 of file IdDictDictionary.h.

entries_it

using IdDictDictionary::entries_it = entries_type::iterator

private

Definition at line 303 of file IdDictDictionary.h.

entries_type

using IdDictDictionary::entries_type = std::vector<IdDictDictEntry*>

private

Definition at line 302 of file IdDictDictionary.h.

groups_const_it

using IdDictDictionary::groups_const_it = groups_type::const_iterator

private

Definition at line 312 of file IdDictDictionary.h.

groups_it

using IdDictDictionary::groups_it = groups_type::iterator

private

Definition at line 311 of file IdDictDictionary.h.

groups_type

using IdDictDictionary::groups_type = std::vector<IdDictGroup*>

private

Definition at line 310 of file IdDictDictionary.h.

regions_const_it

using IdDictDictionary::regions_const_it = regions_type::const_iterator

private

Definition at line 308 of file IdDictDictionary.h.

regions_it

using IdDictDictionary::regions_it = regions_type::iterator

private

Definition at line 307 of file IdDictDictionary.h.

regions_type

using IdDictDictionary::regions_type = std::vector<IdDictRegion*>

private

Definition at line 306 of file IdDictDictionary.h.

size_type

using IdDictDictionary::size_type = Identifier::size_type

Definition at line 34 of file IdDictDictionary.h.

value_type

using IdDictDictionary::value_type = Identifier::value_type

Definition at line 33 of file IdDictDictionary.h.

Constructor & Destructor Documentation

IdDictDictionary() [1/2]

IdDictDictionary::IdDictDictionary ( )

default

IdDictDictionary() [2/2]

IdDictDictionary::IdDictDictionary	(	const std::string &	name,
		const std::string &	version = "",
		const std::string &	date = "",
		const std::string &	author = ""
	)

Definition at line 36 of file IdDictDictionary.cxx.

  : m_name (name),
    m_version (version),
    m_date (date),
    m_author (author)
{
}

~IdDictDictionary()

IdDictDictionary::~IdDictDictionary ( )

default

Member Function Documentation

add_dictentry()

void IdDictDictionary::add_dictentry

(

std::unique_ptr< IdDictDictEntry >

entry

)

Definition at line 171 of file IdDictDictionary.cxx.

                                                                          {
  // Add region to corresponding group
  IdDictGroup* group = find_group(region->group_name());
 
  if (0 == group) {
    m_groups.push_back(std::make_unique<IdDictGroup>(region->group_name()));
    group = m_groups.back().get();
  }
  group->add_dictentry(std::move(region));
}

add_field()

IdDictField * IdDictDictionary::add_field

(

std::unique_ptr< IdDictField >

field

)

Definition at line 101 of file IdDictDictionary.cxx.

                                                                         {
  if (!field) return nullptr;
  return m_fields.emplace (field->name(), std::move(field)).first->second.get();
}

add_region()

void IdDictDictionary::add_region

(

IdDictRegion *

region

)

Definition at line 182 of file IdDictDictionary.cxx.

                                                      {
  m_all_regions.push_back(region);
}

add_subdictionary_name()

void IdDictDictionary::add_subdictionary_name

(

const std::string &

name

)

Definition at line 162 of file IdDictDictionary.cxx.

                                                                   {
  m_subdictionary_names.push_back(name);
}

add_subregion()

IdDictSubRegion * IdDictDictionary::add_subregion

(

std::unique_ptr< IdDictSubRegion >

subregion

)

Definition at line 157 of file IdDictDictionary.cxx.

                                                                        {
  if (!subregion) return nullptr;
  return m_subregions.emplace (subregion->name(), std::move(subregion)).first->second.get();
}

all_regions()

const std::vector< IdDictRegion * > & IdDictDictionary::all_regions ( )

inline

Non-const access to vector of all regions.

Definition at line 399 of file IdDictDictionary.h.

{
    return m_all_regions;
}

build_multirange() [1/3]

MultiRange IdDictDictionary::build_multirange

(

)

const

Get MultiRange for full dictionary.

Definition at line 309 of file IdDictDictionary.cxx.

                                                    {
  MultiRange result;
 
  for (auto& group : m_groups) {
    MultiRange group_mr = group->build_multirange();
 
    for (unsigned int i = 0; i < group_mr.size(); ++i) {
      const Range& range = group_mr[i];
      result.add(range);
    }
  }
 
  return(result);
}

build_multirange() [2/3]

MultiRange IdDictDictionary::build_multirange	(	const ExpandedIdentifier &	region_id,
		const Range &	prefix = Range(),
		const std::string &	last_field = ""
	)		const

Get MultiRange for a specific region_id up to and including 'last_field' If last_field == "", all fields are taken.

Prepend prefix if provided.

Definition at line 324 of file IdDictDictionary.cxx.

                                                                                 {
  MultiRange result;
 
  IdDictDictionary::regions_const_it it;
  if ("" == last_field) {
    // Take all fields
    for (it = m_regions.begin(); it != m_regions.end(); ++it) {
      const IdDictRegion& region = *(*it);
 
      // skip regions created from parents
      if ("dummy" == region.name()) continue;
 
      // skip empty regions - may arise from alternate_regions
      // where a tag selects an empty region
      if (region.is_empty()) continue;
 
      Range range(region.build_range());
      // Check region selection
      if (range.match(region_id)) result.add(std::move(range));
    }
  } else {
    // Not all fields required
    for (it = m_regions.begin(); it != m_regions.end(); ++it) {
      const IdDictRegion& region = *(*it);
 
      // skip regions created from parents
      if ("dummy" == region.name()) continue;
 
      // skip empty regions - may arise from alternate_regions
      // where a tag selects an empty region
      if (region.is_empty()) continue;
 
      Range range(region.build_range());
      // Check region selection
      if (range.match(region_id)) {
        // Build new range up to last_field and add it to result -
        // remove duplicate ranges with addRangeToMR
        Range new_range(prefix); // Prepend with prefix
 
        size_t nimpl = region.n_implementation();
        for (size_t i = 0; i < nimpl; ++i) {
          const IdDictFieldImplementation& impl = region.implementation(i);
 
//              new_range.add(impl.m_field);
          new_range.add(impl.range()->build_range());
 
          if (last_field == impl.range()->field()->name()) {
            break;
          }
        }
        result.add(std::move(new_range));
      }
    }
  }
 
  return(result);
}

build_multirange() [3/3]

MultiRange IdDictDictionary::build_multirange	(	const ExpandedIdentifier &	region_id,
		const std::string &	group_name,
		const Range &	prefix = Range(),
		const std::string &	last_field = ""
	)		const

Get MultiRange for a specific region_id, constrained to be within a specific named group.

The depth of the multirange is up to and including 'last_field' If last_field == "", all fields are taken. Prepend prefix if provided.

Definition at line 384 of file IdDictDictionary.cxx.

                                                                                 {
  MultiRange result;
 
  IdDictDictionary::regions_const_it it;
  if ("" == last_field) {
    // Take all fields
    for (it = m_regions.begin(); it != m_regions.end(); ++it) {
      const IdDictRegion& region = *(*it);
 
      // skip regions created from parents
      if ("dummy" == region.name()) continue;
 
      // skip empty regions - may arise from alternate_regions
      // where a tag selects an empty region
      if (region.is_empty()) continue;
 
      Range range(region.build_range());
      // Check region selection
      if (range.match(region_id) && region.group_name() == group_name) result.add(std::move(range));
    }
  } else {
    // Not all fields required
    for (it = m_regions.begin(); it != m_regions.end(); ++it) {
      const IdDictRegion& region = *(*it);
 
      // skip regions created from parents
      if ("dummy" == region.name()) continue;
 
      // skip empty regions - may arise from alternate_regions
      // where a tag selects an empty region
      if (region.is_empty()) continue;
 
      Range range(region.build_range());
      // Check region selection
      if (range.match(region_id) && region.group_name() == group_name) {
        // Build new range up to last_field and add it to result -
        // remove duplicate ranges with addRangeToMR
        Range new_range(prefix); // Prepend with prefix
 
        size_t nimpl = region.n_implementation();
        for (size_t i = 0; i < nimpl; ++i) {
          const IdDictFieldImplementation& impl = region.implementation(i);
 
//              new_range.add(impl.m_field);
          new_range.add(impl.range()->build_range());
 
          if (last_field == impl.range()->field()->name()) {
            break;
          }
        }
        result.add(std::move(new_range));
      }
    }
  }
 
  return(result);
}

clear()

void IdDictDictionary::clear

(

)

Definition at line 1062 of file IdDictDictionary.cxx.

                             {
  m_subregions.clear();
  m_fields.clear();
  m_groups.clear();
}

copy()

int IdDictDictionary::copy	(	const Identifier &	idin,
		size_t	first_field_index,
		size_t	begin_field_index,
		size_t	end_field_index,
		size_t	region_index,
		Identifier &	idout
	)		const

Copy a number of fields of the value_type id into another value_type id.

Copy a number of fields of the bits32 id into another bits32 id.

One specifies the begin and end (inclusive) field indexes desired and passes in the region index to be used for decoding. The region index is obtained from find_region. The first_field_index is normally 0. It is non-zero when fields 0 to first_field_index -1 are missing from the compact

One specifies the begin and end (inclusive) field indexes desired and passes in the region index to be used for decoding. The region index is obtained from find_region. The first_field_index is normally 0. It is non-zero when fields 0 to first_field_index -1 are missing from the compact. In this case, idout is shift by the number of missing bits, if possible.

Definition at line 897 of file IdDictDictionary.cxx.

                                                {
  idout = Identifier();
  if (region_index >= m_regions.size()) {
    std::cout << "IdDictDictionary::copy - region index too large. Index, nregions "
              << region_index << " " << m_regions.size() << std::endl;
    return(1);
  }
 
  const IdDictRegion& region = *m_regions[region_index];
 
  if (first_field_index >= region.n_implementation() ||
      begin_field_index >= region.n_implementation() ||
      end_field_index >= region.n_implementation()) {
    std::cout << "IdDictDictionary::copy - field index too large. Indexes first, begin, end, nfields "
              << first_field_index << " "
              << begin_field_index << " "
              << end_field_index << " "
              << region.n_implementation()
              << std::endl;
    return(1);
  }
 
  size_t missing_offset = 0;
  if (first_field_index) {
    if (first_field_index > begin_field_index) {
      std::cout << "IdDictDictionary::copy - first_field_index > begin_field_index. Indexes "
                << first_field_index << " " << begin_field_index << std::endl;
      return(1);
    }
    // One or more fields missing from prefix, get the offset
    missing_offset = region.implementation(first_field_index).bits_offset();
  }
 
  size_t prefix_offset = 0;
  if (begin_field_index) {
    if (begin_field_index > end_field_index) {
      std::cout << "IdDictDictionary::copy - begin_field_index > end_field_index. Indexes "
                << begin_field_index << " " << end_field_index << std::endl;
      return(1);
    }
    // One or more fields missing from prefix, get the offset
    prefix_offset = region.implementation(begin_field_index).bits_offset();
  }
 
  const IdDictFieldImplementation& impl = region.implementation(end_field_index);
  size_t suffix_offset = impl.bits() + impl.bits_offset();
 
  size_t position = Identifier::NBITS; // overall bit position
 
  if (position < prefix_offset - missing_offset) {
    std::cout << "IdDictDictionary::copy - position < prefix + missing. "
              << prefix_offset << " " << missing_offset << std::endl;
    return(1);
  }
 
 
  if (position < suffix_offset + missing_offset) {
    std::cout << "IdDictDictionary::copy - position < suffix + missing. "
              << suffix_offset << " " << missing_offset << std::endl;
    return(1);
  }
 
 
  // prepare the mask for copying
 
  Identifier::value_type mask = Identifier::ALL_BITS;
 
  Identifier::value_type prefix_mask =
    prefix_offset ? (static_cast<Identifier::value_type>(1) << (position - prefix_offset + missing_offset)) - 1 : 0;
 
  Identifier::value_type suffix_mask =
    (static_cast<Identifier::value_type>(1) << (position - suffix_offset + missing_offset)) - 1;
 
  mask -= prefix_mask + suffix_mask;
 
  idout = idin.mask_shift(mask, missing_offset);
 
 
  return(0);
}

dict_tag()

const std::string & IdDictDictionary::dict_tag ( ) const

inline

Access to the dictionary tag.

Definition at line 378 of file IdDictDictionary.h.

                                 {
    return m_dict_tag;
}

do_checks()

bool IdDictDictionary::do_checks

(

)

const

Checks are performed by default in debug compilation and NOT in optimized compilation.

One can switch or query this mode for any idHelper with the following methods:

Definition at line 984 of file IdDictDictionary.cxx.

                                      {
  return(m_do_checks);
}

do_neighbours()

bool IdDictDictionary::do_neighbours

(

)

const

Neighbour initialization is performed by default One can switch or query this mode for any idHelper with the following methods:

Definition at line 994 of file IdDictDictionary.cxx.

                                          {
  return(m_do_neighbours);
}

dump()

void IdDictDictionary::dump

(

)

const

Dump regions and trees for each group.

Definition at line 1070 of file IdDictDictionary.cxx.

{
  std::cout << "=== IdDictDictionary " << m_name << " " << m_version << " "
            << m_date << " " << m_author << "\n";
  for (const auto& g : m_groups) {
    g->dump();
  }
  std::cout.flush();
}

file_name()

const std::string & IdDictDictionary::file_name ( ) const

inline

Access to file name.

Definition at line 371 of file IdDictDictionary.h.

                                 {
    return m_file_name;
}

find_field() [1/2]

IdDictField * IdDictDictionary::find_field

(

const std::string &

name

)

Definition at line 65 of file IdDictDictionary.cxx.

                                                               {
  auto it = m_fields.find(name);
 
  if (it == m_fields.end()) {
    // If parent exists, look for field there
    if (m_parent_dict) {
      it = m_parent_dict->m_fields.find(name);
      if (it == m_parent_dict->m_fields.end()) {
        return nullptr;
      }
    } else {
      return nullptr;
    }
  }
 
  return it->second.get();
}

find_field() [2/2]

const IdDictField * IdDictDictionary::find_field

(

const std::string &

name

)

const

Definition at line 47 of file IdDictDictionary.cxx.

                                                                           {
  auto it = m_fields.find(name);
 
  if (it == m_fields.end()) {
    // If parent exists, look for field there
    if (m_parent_dict) {
      it = m_parent_dict->m_fields.find(name);
      if (it == m_parent_dict->m_fields.end()) {
        return nullptr;
      }
    } else {
      return nullptr;
    }
  }
 
  return it->second.get();
}

find_group() [1/2]

IdDictGroup * IdDictDictionary::find_group

(

const std::string &

group_name

)

Definition at line 141 of file IdDictDictionary.cxx.

                                                        {
  for (auto& g : m_groups) {
    if (g && g->name() == group_name) return g.get();
  }
  return nullptr;
}

find_group() [2/2]

const IdDictGroup * IdDictDictionary::find_group

(

const std::string &

group_name

)

const

Definition at line 149 of file IdDictDictionary.cxx.

                                                              {
  for (const auto& g : m_groups) {
    if (g && g->name() == group_name) return g.get();
  }
  return nullptr;
}

find_label()

const IdDictLabel * IdDictDictionary::find_label	(	const std::string &	field,
		const std::string &	label
	)		const

Definition at line 84 of file IdDictDictionary.cxx.

                                                                                 {
  const IdDictField* idField = find_field(field);
 
  if (!idField) return nullptr;
 
  return(idField->find_label(label));
}

find_region() [1/6]

const IdDictRegion * IdDictDictionary::find_region

(

const ExpandedIdentifier &

id

)

const

Definition at line 274 of file IdDictDictionary.cxx.

                                                                                    {
  return find_region(id, "");
}

find_region() [2/6]

const IdDictRegion * IdDictDictionary::find_region	(	const ExpandedIdentifier &	id,
		const std::string &	group_name
	)		const

Definition at line 278 of file IdDictDictionary.cxx.

                                                                                                                 {
  // Find first region that matches id
 
  IdDictRegion* pRegion = 0;
 
  IdDictDictionary::regions_const_it it;
 
  for (it = m_regions.begin(); it != m_regions.end(); ++it) {
    IdDictRegion& region = *(*it);
    if ((group_name != "") && (region.group_name() != group_name)) continue;
 
    Range range = region.build_range();
 
    if (range.match(id) && range.fields() >= id.fields()) {
      pRegion = &region;
    }
  }
 
  return(pRegion);
}

find_region() [3/6]

int IdDictDictionary::find_region	(	const ExpandedIdentifier &	id,
		size_type &	index
	)		const

Definition at line 254 of file IdDictDictionary.cxx.

                                                                                  {
  // Find first region that matches id
 
  IdDictDictionary::regions_const_it it;
 
  size_type i = 0;
  for (it = m_regions.begin(); it != m_regions.end(); ++it, ++i) {
    const IdDictRegion& region = *(*it);
 
    Range range = region.build_range();
 
    if (range.match(id) && range.fields() >= id.fields()) {
      index = i;
      return(0);
    }
  }
 
  return(1);
}

find_region() [4/6]

const IdDictRegion * IdDictDictionary::find_region

(

const std::string &

region_name

)

const

Definition at line 114 of file IdDictDictionary.cxx.

                                                                {
  return find_region(region_name, "");
}

find_region() [5/6]

IdDictRegion * IdDictDictionary::find_region	(	const std::string &	region_name,
		const std::string &	group_name
	)

Definition at line 119 of file IdDictDictionary.cxx.

                                                                                       {
  for (IdDictRegion* region : m_regions) {
    if (!region) continue;
    if ((group_name != "") && (region->group_name() != group_name)) continue;
    if ((region_name != "") && (region->name() != region_name)) continue;
    return region;
  }
  return nullptr;
}

find_region() [6/6]

const IdDictRegion * IdDictDictionary::find_region	(	const std::string &	region_name,
		const std::string &	group_name
	)		const

Definition at line 130 of file IdDictDictionary.cxx.

                                                                                             {
  for (IdDictRegion* region : m_regions) {
    if (!region) continue;
    if ((group_name != "") && (region->group_name() != group_name)) continue;
    if ((region_name != "") && (region->name() != region_name)) continue;
    return region;
  }
  return nullptr;
}

find_subregion()

IdDictSubRegion * IdDictDictionary::find_subregion

(

const std::string &

subregion_name

)

Definition at line 107 of file IdDictDictionary.cxx.

                                                      {
  auto it = m_subregions.find(name);
  if (it == m_subregions.end()) return nullptr;
  return it->second.get();
}

generate_implementation()

void IdDictDictionary::generate_implementation	(	const IdDictMgr &	idd,
		const std::string &	tag = ""
	)

Definition at line 196 of file IdDictDictionary.cxx.

                                                                     {
  if (Debugger::debug()) {
    std::cout << "IdDictDictionary::generate_implementation>" << std::endl;
  }
 
  if (!m_generated_implementation) {
    // Propagate to each region and copy their generation into the
    // dict's vector.
    for (auto& g : m_groups) {
      g->generate_implementation(idd, *this, tag);
      // Get regions from group and save in m_regions
      for (IdDictRegion* re : g->regions()) {
        m_regions.push_back(re);
      }
    }
 
    // Loop again over groups and set the bit-packing - starting at
    // level 0
    for (auto& g : m_groups) {
      // Copy to temporary vector all regions in the group. And
      // look for regions in local m_regions vector for any
      // regions "dummy", which come from reference
      // dictionaries.
      // Skip special group
      if ("dummy" == g->name()) continue;
 
      get_bits(m_regions, 0, g->name());
    }
 
    // Set integral over the number of bits
    integrate_bits();
 
    for (auto& g : m_groups) {
      g->build_region_tree();
    }
 
    // Set neighbours for regions
    IdDictDictionary::regions_it itr;
    for (itr = m_regions.begin(); itr != m_regions.end(); ++itr) {
      (*itr)->find_neighbours(*this);
    }
 
    m_generated_implementation = true;
  }
}

get_label_value()

int IdDictDictionary::get_label_value	(	const std::string &	field,
		const std::string &	label,
		int &	value
	)		const

Definition at line 92 of file IdDictDictionary.cxx.

                                                                                                      {
  const IdDictLabel* idLabel = find_label(field, label);
 
  if (!idLabel || !idLabel->valued()) return(1);
 
  value = idLabel->value();
  return(0);
}

integrate_bits()

void IdDictDictionary::integrate_bits

(

)

Set up integral of bits for efficient unpacking.

Definition at line 300 of file IdDictDictionary.cxx.

                                 {
  // For each region, loop over its levels and set the bit offset
  // for each FieldImplementation
 
  for (IdDictRegion* region : m_regions) {
    region->integrate_bits();
  }
}

n_regions()

size_t IdDictDictionary::n_regions ( ) const

inline

Number of contained regions.

Definition at line 363 of file IdDictDictionary.h.

{
    return m_regions.size();
}

name()

const std::string & IdDictDictionary::name ( ) const

inline

Dictionary name.

Definition at line 336 of file IdDictDictionary.h.

{
    return m_name;
}

pack32() [1/2]

int IdDictDictionary::pack32	(	const ExpandedIdentifier &	id,
		size_t	index1,
		size_t	index2,
		Identifier &	packedId
	)		const

Pack to 32bits the subset of id between (inclusive) index1 and index2 - this is generic, i.e.

not the most efficient

Assumptions:

• packedId is initialized to 0
• the expanded id begins at index = 0
• index1,2 correspond to the level/field number, this is thus the same as the index into the expanded id due to the previous assumption.

First we need to check whether the specified identifier really matches the Dictionary specifications.

However, we stop the search in the set of regions at the first matching region. Should we request that only one region matches ????

Definition at line 459 of file IdDictDictionary.cxx.

                                                     {
  packedId = 0;
 
 
  // Preconditions...
 
  if (index2 < index1) {
    // bad parameters.
    return(1);
  }
 
  if (index1 >= id.fields()) {
    // nothing very useful !!
    return(1);
  }
 
  if (index2 >= id.fields()) {
    // bad parameter...
    return(1);
  }
 
  for (size_t k = 0; k < m_regions.size(); ++k) {
    bool selected = true;
 
    const IdDictRegion& region = *m_regions[k];
 
    // Must skip empty regions - can arise when a tag selects an
    // empty region
    if (region.is_empty()) continue;
 
    for (size_t i = 0; i < region.n_implementation(); ++i) {
      if (i >= id.fields()) break;
 
      const IdDictFieldImplementation& impl = region.implementation(i);
 
      if (!impl.field().match(id[i])) {
        selected = false;
        break;
      }
    }
 
    if (selected) {
      size_t position = Identifier::NBITS;
      // We have the proper region.
      for (size_t i = index1; i <= index2; ++i) {
        const IdDictFieldImplementation& impl = region.implementation(i);
 
        Identifier::value_type index = impl.ored_field().get_value_index(id[i]);
 
        if (0 == position && impl.bits() > 0) {
          return(1);
        }
 
        position -= impl.bits();
        packedId |= (index << position);
      }
      break;
    }
  }
 
 
  return(0);
}

pack32() [2/2]

int IdDictDictionary::pack32	(	const int *	fields,
		size_t	index1,
		size_t	index2,
		size_t	region_index,
		Identifier &	packedId,
		size_t	first_field_index = 0
	)		const

Pack to 32bits the subset of id between (inclusive) index1 and index2.

Here one must provide the region index, which can be found with find_region. This is more efficient than the above pack32.

Assumptions: (different than the previous pack32)

• packedId is NOT initialized to 0 - allows to just overwrite the specified fields
• the field array begins at index1, i.e. NOT the first field
• the field array field array has a length of index2-index1+1
• index1,2 correspond to the level/field number
• first_field_index defines the offset for packing. Normally, this is this is 0. But this may be a field > 0, but of course <= index1

Definition at line 536 of file IdDictDictionary.cxx.

                                                         {
  // Preconditions...
 
  if (m_do_checks) {
    if (index2 < index1) {
      // bad parameters.
      std::cout << "IdDictDictionary::pack32 - index2 < index1 - 1,2"
                << index1 << " " << index2 << std::endl;
      return(1);
    }
 
    if (region_index >= m_regions.size()) {
      // bad parameters.
      std::cout << "IdDictDictionary::pack32 - region index incorrect - index,size"
                << region_index << " " << m_regions.size() << std::endl;
      return(1);
    }
  }
 
 
  // Get the region
  const IdDictRegion& region = *m_regions[region_index];
 
  if (m_do_checks) {
    if (region.is_empty()) {
      std::cout << "IdDictDictionary::pack32 - region id empty" << std::endl;
      // bad parameters.
      return(1);
    }
    if (index1 < first_field_index) {
      std::cout << "IdDictDictionary::pack32 - first_field_index > index1 "
                << first_field_index << " " << index1 << std::endl;
      return(1);
    }
  }
 
  // Set the starting position
  size_t position = Identifier::NBITS;
  if (!first_field_index) {
    const IdDictFieldImplementation& impl = region.implementation(index1);
    position -= impl.bits_offset();
  }
 
  size_t field_index = 0;
  for (size_t i = index1; i <= index2; ++i, ++field_index) {
    const IdDictFieldImplementation& impl = region.implementation(i);
 
    if (m_do_checks) {
      // Field should be within allowed range
      if (!impl.ored_field().match(fields[field_index])) {
        std::cout << "IdDictDictionary::pack32 - field does NOT match: value, allowed values "
                  << fields[field_index] << " " << (std::string) impl.ored_field()
                  << std::endl;
        // bad parameters.
        return(1);
      }
 
      // Check that we don't try to go below 0
      if (0 == position && impl.bits() > 0) {
        std::cout << "IdDictDictionary::pack32 - going past 0" << std::endl;
        return(1);
      }
    }
 
    Identifier::value_type index;
    if (impl.decode_index()) {
      index = impl.ored_field().get_value_index(fields[field_index]);
    } else {
      index = (Identifier::value_type) fields[field_index];
    }
 
    position -= impl.bits();
    packedId |= (index << position);
  }
 
 
  return(0);
}

region()

const IdDictRegion & IdDictDictionary::region ( size_t  i ) const

inline

Region at index i.

Definition at line 354 of file IdDictDictionary.h.

{
    return *m_regions.at(i);
}

reset()

int IdDictDictionary::reset	(	size_t	index1,
		size_t	index2,
		size_t	region_index,
		Identifier &	packedId
	)		const

Reset fields from index1 to index2.

Definition at line 623 of file IdDictDictionary.cxx.

                                                        {
  // Preconditions...
 
  if (m_do_checks) {
    if (index2 < index1) {
      // bad parameters.
      std::cout << "IdDictDictionary::pack32 - index2 < index1 - 1,2"
                << index1 << " " << index2 << std::endl;
      return(1);
    }
 
    if (region_index >= m_regions.size()) {
      // bad parameters.
      std::cout << "IdDictDictionary::pack32 - region index incorrect - index,size"
                << region_index << " " << m_regions.size() << std::endl;
      return(1);
    }
  }
 
 
  // Get the region
  const IdDictRegion& region = *m_regions[region_index];
 
  if (m_do_checks) {
    if (region.is_empty()) {
      std::cout << "IdDictDictionary::pack32 - region id empty" << std::endl;
      // bad parameters.
      return(1);
    }
  }
 
  size_t field_index = 0;
  for (size_t i = index1; i <= index2; ++i, ++field_index) {
    const IdDictFieldImplementation& impl = region.implementation(i);
 
    size_t position = Identifier::NBITS - impl.bits_offset() - impl.bits();
 
    Identifier::value_type mask = (((Identifier::value_type) 1 << impl.bits()) - 1) << position;
 
    mask ^= Identifier::ALL_BITS;
 
    packedId &= (mask);
  }
  return(0);
}

reset_implementation()

void IdDictDictionary::reset_implementation

(

)

Definition at line 243 of file IdDictDictionary.cxx.

                                            {
  if (m_generated_implementation) {
    m_regions.clear();
    for (auto& g : m_groups) {
      g->reset_implementation();
    }
    m_generated_implementation = false;
  }
}

resolve_references()

void IdDictDictionary::resolve_references

(

IdDictMgr &

idd

)

Definition at line 186 of file IdDictDictionary.cxx.

                                                        {
  for (auto& p : m_subregions) {
    p.second->resolve_references(idd, *this);
  }
 
  for (size_t index = 0; auto& g : m_groups) {
    g->resolve_references(idd, *this, index);
  }
}

set_dict_tag()

void IdDictDictionary::set_dict_tag ( const std::string &  tag )

inline

Set the dictionary tag.

Definition at line 392 of file IdDictDictionary.h.

                                                  {
    m_dict_tag = tag;
}

set_do_checks()

void IdDictDictionary::set_do_checks

(

bool

do_checks

)

Definition at line 989 of file IdDictDictionary.cxx.

                                              {
  m_do_checks = do_checks;
}

set_do_neighbours()

void IdDictDictionary::set_do_neighbours

(

bool

do_neighbours

)

Definition at line 999 of file IdDictDictionary.cxx.

                                                      {
  m_do_neighbours = do_neighbours;
}

set_file_name()

void IdDictDictionary::set_file_name ( const std::string &  name )

inline

Set file name.

Definition at line 385 of file IdDictDictionary.h.

                                                    {
    m_file_name = name;
}

set_parent_dict()

void IdDictDictionary::set_parent_dict

(

IdDictDictionary *

parent_dict

)

Definition at line 166 of file IdDictDictionary.cxx.

{
  m_parent_dict = parent_dict;
}

sort()

void IdDictDictionary::sort

(

)

Sort:

Prerequisite: first verify the dictionary - no overlaps

Then loop over regions and sort according to their first identifier

Definition at line 1048 of file IdDictDictionary.cxx.

                            {
  // verify
  if (verify()) {
    std::map< ExpandedIdentifier, IdDictDictEntry* > regions;
 
    for (auto& g : m_groups) {
      g->sort();
    }
  } else {
    std::cout << "IdDictDictionary::sort - WARNING verify is FALSE - cannot sort "
              << std::endl;
  }
}

unpack() [1/3]

int IdDictDictionary::unpack	(	const Identifier &	id,
		size_t	first_field_index,
		size_t	field_index,
		size_t	region_index,
		int &	field
	)		const

Unpack a single field of the value_type id.

Unpack a single field of the bits32 id.

One specifies the field index desired and passes in the region index to be used for decoding. The region index is obtained from find_region. The first_field_index is normally 0. It is non-zero when fields 0 to first_field_index -1 are missing from the compact

Definition at line 810 of file IdDictDictionary.cxx.

                                           {
  field = 0;
 
  if (m_do_checks) {
    // Check regions
    if (region_index >= m_regions.size()) {
      std::cout << "IdDictDictionary::unpack - region index too large. Index, nregions "
                << region_index << " " << m_regions.size() << std::endl;
      return(1);
    }
  }
 
  const IdDictRegion& region = *m_regions.at(region_index);
 
  if (m_do_checks) {
    // check number of fields
    if (field_index >= region.n_implementation()) {
      std::cout << "IdDictDictionary::unpack - field index too large. Index, nfields "
                << field_index << " " << region.n_implementation()
                << std::endl;
      return(1);
    }
  }
 
  const IdDictFieldImplementation& impl = region.implementation(field_index);
  size_t prefix_offset = 0;
 
  size_t position = Identifier::NBITS; // overall bit position
 
  // One or more fields missing from prefix, get the offset
  if (first_field_index) {
    if (m_do_checks) {
      if (first_field_index >= region.n_implementation()) {
        std::cout << "IdDictDictionary::unpack - first_field_index too large. Index, nfields "
                  << first_field_index << " " << region.n_implementation()
                  << std::endl;
        return(1);
      }
    }
 
    // One or more fields missing from prefix, get the offset
    prefix_offset = region.implementation(first_field_index).bits_offset();
 
    if (m_do_checks) {
      // Should have a non-zero number of bits
      if (impl.bits() == 0) {
        std::cout << "IdDictDictionary::unpack - no bits for this field. Region, field indexes "
                  << region_index << " " << field_index << std::endl;
        return(1);
      }
 
      // Check the shift value
      if (impl.bits() + impl.bits_offset() - prefix_offset > position) {
        std::cout << "IdDictDictionary::unpack - bits + offset too large. Region, field indexes, bits, offset "
                  << region_index << " " << field_index << " "
                  << impl.bits() << " " << impl.bits_offset() << " " << prefix_offset
                  << std::endl;
        return(1);
      }
    }
  }
 
  Identifier::value_type mask = (static_cast<Identifier::value_type>(1) << impl.bits()) - 1;
 
  size_t index = id.extract(position -= impl.bits() + impl.bits_offset() - prefix_offset, mask);
 
  field = index;
  if (impl.decode_index()) field = impl.ored_field().get_value_at(index);
 
 
  return(0);
}

unpack() [2/3]

int IdDictDictionary::unpack	(	const std::string &	group,
		const Identifier &	id,
		const ExpandedIdentifier &	prefix,
		size_t	index2,
		const std::string &	sep,
		std::string &	unpackedId
	)		const

Unpack the value_type id to a string for a given group, considering the provided prefix (result will include the prefix) and up to index2 - (index1 is assumed to be 0, i.e.

part of prefix).

Returns 0 on success, nonzero on error.

Definition at line 700 of file IdDictDictionary.cxx.

{
  const IdDictGroup* g = find_group (group);
  ExpandedIdentifier unpacked;
  std::vector<const IdDictFieldImplementation*> impls;
  int ret = 1;
  if (g) {
    ret = g->unpack (id, prefix, index2, unpacked, &impls);
  }
  if (ret == 0) {
    assert (unpacked.fields() == impls.size());
    for (size_t i = 0; i < unpacked.fields(); ++i) {
      // Add value to string
 
      std::string str_value("nil");
 
      const IdDictFieldImplementation& impl = *impls[i];
      ExpandedIdentifier::element_type value = unpacked[i];
 
      // The policy below is:
      //   - if a value is a character string or name, just add this name
      //   - if a value is a number, then prefix it with the
      //     name of the field
      //
      // NOTE: min/max is a number, but for value/label we
      // distinguish between number and name by looking for an IdDictLabel
      const IdDictRange* range = impl.range();
      const IdDictLabel* label = range->field()->find_label(range->label());
      switch (range->specification()) {
      case IdDictRange::by_minmax:
        // For a range of values (numbers), add in the field name
        str_value = range->field()->name() + ' '+std::to_string(value);
        break;
 
      case IdDictRange::by_value:
      case IdDictRange::by_label:
        str_value = "";
        if (!label) {
          // Is a number, add in field name
          str_value += range->field()->name() + ' ';
        }
        str_value += range->label();
        break;
 
      case IdDictRange::by_values:
      case IdDictRange::by_labels:
        str_value = "";
        // Is a name
        if (label) {
          // Found label with "find_label" on the field
          if (label->valued()) {
            str_value += range->label();
          }
        } else {
          // If not found with the "find" above, we must
          // get the value and name from the range
          // itself.
 
          unsigned int index1 = 0;
          for (int v : range->values()) {
            if (value == v) break;
            ++index1;
          }
 
          if (index1 < range->labels().size()) {
            if (isNumber(range->labels()[index1])) {
              str_value += range->field()->name() + ' ';
            }
            str_value += range->labels()[index1];
          } else {
            std::cout << "IdDictDictionary::unpack - Could not find value." << std::endl;
            std::cout << "value " << value << std::endl;
            std::cout << "field values " << std::endl;
            for (int v : range->values()) {
              std::cout << v << " ";
            }
            std::cout << std::endl;
          }
        }
        break;
 
      case IdDictRange::unknown:
 
        std::cout << "unknown" << std::endl;
 
        break;
      }
 
      if (i > 0) unpackedId += sep;
      unpackedId += str_value;
    }
  }
 
  return ret;
}

unpack() [3/3]

int IdDictDictionary::unpack	(	const std::string &	group,
		const Identifier &	id,
		const ExpandedIdentifier &	prefix,
		size_t	index2,
		ExpandedIdentifier &	unpackedId
	)		const

Unpack the value_type id to an expanded Identifier for a given group, considering the provided prefix (result will include the prefix) and up to index2 - (index1 is assumed to be 0, i.e.

part of prefix).

Returns 0 on success, nonzero on error.

Definition at line 679 of file IdDictDictionary.cxx.

{
  const IdDictGroup* g = find_group (group);
  int ret = 1;
  if (g)  {
    ret = g->unpack (id, prefix, index2, unpackedId);
  }
  return ret;
}

verify()

bool IdDictDictionary::verify

(

)

const

Here, we verify global constraints : (this must only be applied after the resolve_references and generate_implementation operations)

a) There should be no overlap between any region duet.

b) In a dictionary, a given field (ie. with a given name) must always be referenced at the same depth across all regions and subregions.

c) When a region specifies a reference to a sub-dictionary :

• the reference must be the last entry in the region
• the first region entries of all regions should not overlap (regardless of the definition of the sub-dictionary). IE the first fields in these regions must be sufficient to unambiguously select the sub-dictionary.

d) Within a dictionary, a given field must always be described either through an enumeration, or through its bounds. However, the various usages of a given field may specify different tag set (for enumerations) or bounds (for a bounded field).

Definition at line 1027 of file IdDictDictionary.cxx.

                                    {
  // check #1
 
  MultiRange mr = build_multirange();
 
  if (mr.has_overlap()) return(false);
 
 
  return(true);
}

version()

const std::string & IdDictDictionary::version ( ) const

inline

Dictionary version.

Definition at line 345 of file IdDictDictionary.h.

{
    return m_version;
}

Member Data Documentation

m_all_regions

std::vector<IdDictRegion*> IdDictDictionary::m_all_regions

private

Definition at line 317 of file IdDictDictionary.h.

m_author

std::string IdDictDictionary::m_author {}

private

Definition at line 300 of file IdDictDictionary.h.

m_date

std::string IdDictDictionary::m_date {}

private

Definition at line 299 of file IdDictDictionary.h.

m_dict_tag

std::string IdDictDictionary::m_dict_tag {}

private

Definition at line 323 of file IdDictDictionary.h.

m_do_checks

bool IdDictDictionary::m_do_checks {false}

private

Definition at line 325 of file IdDictDictionary.h.

m_do_neighbours

bool IdDictDictionary::m_do_neighbours {true}

private

Definition at line 326 of file IdDictDictionary.h.

m_fields

std::map<std::string, std::unique_ptr<IdDictField> > IdDictDictionary::m_fields

private

Definition at line 314 of file IdDictDictionary.h.

m_file_name

std::string IdDictDictionary::m_file_name {}

private

Definition at line 322 of file IdDictDictionary.h.

m_generated_implementation

bool IdDictDictionary::m_generated_implementation {false}

private

Definition at line 324 of file IdDictDictionary.h.

m_groups

std::vector<std::unique_ptr<IdDictGroup> > IdDictDictionary::m_groups

private

Definition at line 318 of file IdDictDictionary.h.

m_name

std::string IdDictDictionary::m_name {}

private

Definition at line 297 of file IdDictDictionary.h.

m_parent_dict

IdDictDictionary* IdDictDictionary::m_parent_dict {nullptr}

private

Definition at line 320 of file IdDictDictionary.h.

m_regions

std::vector<IdDictRegion*> IdDictDictionary::m_regions

private

Definition at line 316 of file IdDictDictionary.h.

m_subdictionary_names

std::vector<std::string> IdDictDictionary::m_subdictionary_names

private

Definition at line 319 of file IdDictDictionary.h.

m_subregions

std::map<std::string, std::unique_ptr<IdDictSubRegion> > IdDictDictionary::m_subregions

private

Definition at line 315 of file IdDictDictionary.h.

m_version

std::string IdDictDictionary::m_version {}

private

Definition at line 298 of file IdDictDictionary.h.

---

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

• IdDictDictionary.h
• IdDictDictionary.cxx