IdDictRange Class Reference

#include <IdDictRange.h>

Inheritance diagram for IdDictRange:

Collaboration diagram for IdDictRange:

Public Types
enum	specification_type {   unknown , by_value , by_values , by_label ,   by_labels , by_minmax }
enum	continuation_mode {   none , has_next , has_previous , has_both ,   wrap_around }

Public Member Functions
	IdDictRange (const std::string &field_name)
	Set name only; no range information.
	IdDictRange (const std::string &field_name, const std::string &label)
	By label.
	IdDictRange (const std::string &field_name, int value)
	By value.
	IdDictRange (const std::string &field_name, int minvalue, int maxvalue)
	By minmax.
	IdDictRange (const std::string &field_name, const std::vector< int > &values)
	By list of values.
	IdDictRange (const std::string &field_name, const std::vector< std::string > &labels)
	By list of labels.
virtual	~IdDictRange ()=default
const std::string &	field_name () const
const std::string &	label () const
const IdDictField *	field () const
specification_type	specification () const
const std::vector< int > &	values () const
const std::vector< std::string > &	labels () const
void	set_range (const std::string &label)
	By label.
void	set_range (int value)
	By value.
void	set_range (int minvalue, int maxvalue)
	By minmax.
void	set_range (const std::vector< int > &values)
	By list of values.
void	set_range (const std::vector< std::string > &labels)
	By list of labels.
void	set_prev (int prev)
	Set previous value and adjust continuation mode.
void	set_next (int next)
	Set next value and adjust continuation mode.
void	set_wrap_around ()
	Enable wraparound.
virtual void	resolve_references (IdDictMgr &idd, IdDictDictionary &dictionary, IdDictRegion &region) override
virtual void	generate_implementation (const IdDictMgr &idd, IdDictDictionary &dictionary, IdDictRegion &region, const std::string &tag="") override
virtual Range	build_range () const override
virtual void	reset_implementation ()
virtual bool	verify () const
virtual void	clear ()

Private Attributes
std::string	m_field_name
IdDictField *	m_field {}
specification_type	m_specification {unknown}
std::string	m_tag
std::string	m_label
int	m_value {}
int	m_minvalue {}
int	m_maxvalue {}
int	m_prev_value {}
int	m_next_value {}
continuation_mode	m_continuation_mode {none}
std::vector< std::string >	m_labels
std::vector< int >	m_values
bool	m_resolved_references {}

Detailed Description

Definition at line 18 of file IdDictRange.h.

Member Enumeration Documentation

continuation_mode

enum IdDictRange::continuation_mode

Enumerator
none
has_next
has_previous
has_both
wrap_around

Definition at line 28 of file IdDictRange.h.

                          {
        none,
        has_next,
        has_previous,
        has_both,
        wrap_around
    };

specification_type

enum IdDictRange::specification_type

Enumerator
unknown
by_value
by_values
by_label
by_labels
by_minmax

Definition at line 20 of file IdDictRange.h.

                           {
        unknown,
        by_value,
        by_values,
        by_label,
        by_labels,
        by_minmax
    };

Constructor & Destructor Documentation

IdDictRange() [1/6]

IdDictRange::IdDictRange

(

const std::string &

field_name

)

Set name only; no range information.

Definition at line 16 of file IdDictRange.cxx.

  : m_field_name (field_name)
{
}

IdDictRange() [2/6]

IdDictRange::IdDictRange	(	const std::string &	field_name,
		const std::string &	label )

By label.

Definition at line 23 of file IdDictRange.cxx.

  : m_field_name (field_name)
{
  set_range (label);
}

IdDictRange() [3/6]

IdDictRange::IdDictRange	(	const std::string &	field_name,
		int	value )

By value.

Definition at line 32 of file IdDictRange.cxx.

  : m_field_name (field_name)
{
  set_range (value);
}

IdDictRange() [4/6]

IdDictRange::IdDictRange	(	const std::string &	field_name,
		int	minvalue,
		int	maxvalue )

By minmax.

Definition at line 41 of file IdDictRange.cxx.

  : m_field_name (field_name)
{
  set_range (minvalue, maxvalue);
}

IdDictRange() [5/6]

IdDictRange::IdDictRange	(	const std::string &	field_name,
		const std::vector< int > &	values )

By list of values.

Definition at line 50 of file IdDictRange.cxx.

  : m_field_name (field_name)
{
  set_range (values);
}

IdDictRange() [6/6]

IdDictRange::IdDictRange	(	const std::string &	field_name,
		const std::vector< std::string > &	labels )

By list of labels.

Definition at line 59 of file IdDictRange.cxx.

  : m_field_name (field_name)
{
  set_range (labels);
}

~IdDictRange()

virtual IdDictRange::~IdDictRange ( )

virtualdefault

Member Function Documentation

build_range()

Range IdDictRange::build_range ( ) const

overridevirtual

Implements IdDictRegionEntry.

Definition at line 237 of file IdDictRange.cxx.

                               {
  Range result;
 
  Range::field field;
  switch (m_specification) {
  case by_value:
  case by_label: {
    field.set(m_value, m_value);
    break;
  }
 
  case by_values:
  case by_labels: {
    field.set(m_values);
    break;
  }
 
  case by_minmax: {
    field.set(m_minvalue, m_maxvalue);
    break;
  }
 
  case unknown: {
    break;
  }
  }
  if (wrap_around == m_continuation_mode) {
    field.set(true);
  } else if (has_previous == m_continuation_mode) {
    field.set_previous(m_prev_value);
  } else if (has_next == m_continuation_mode) {
    field.set_next(m_next_value);
  } else if (has_both == m_continuation_mode) {
    field.set_previous(m_prev_value);
    field.set_next(m_next_value);
  }
  result.add(std::move(field));
  return(result);
}

clear()

void IdDictRegionEntry::clear ( )

virtualinherited

Definition at line 29 of file IdDictRegionEntry.cxx.

                              {
}

field()

const IdDictField * IdDictRange::field ( ) const

inline

Definition at line 156 of file IdDictRange.h.

{
  return m_field;
}

field_name()

const std::string & IdDictRange::field_name ( ) const

inline

Definition at line 142 of file IdDictRange.h.

{
  return m_field_name;
}

generate_implementation()

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

overridevirtual

Reimplemented from IdDictRegionEntry.

Definition at line 177 of file IdDictRange.cxx.

                                                                                                             {
  // Add IdDictFieldImplementation to this region
 
  // NOTE: we DO NOT protect this method with
  // m_generated_implementation because the same object may be
  // called more than once because there are IdDictRangeRef's which
  // point to the same IdDictRange's.
 
  if (Debugger::debug()) {
    std::cout << "IdDictRange::generate_implementation>" << std::endl;
  }
 
  IdDictFieldImplementation& impl = region.new_implementation();
  impl.set_range(this);
  if (m_field->index() == 0) {
    m_field->set_index(region.fieldSize() - 1);
  } else if (m_field->index() != (region.fieldSize() - 1)) {
    std::cout << "Bad field index for " << m_field_name
              << " index " << m_field->index()
              << " in dictionary " << dictionary.name()
              << " region #" << region.index()
              << " group " << region.group_name()
              << " tag " << region.tag()
              << " size " << (region.n_implementation() - 1)
              << std::endl;
  }
 
  size_t index = region.n_implementation() - 1;
  if (region.n_implementation() <= index) {
    std::cout << "IdDictRange::generate_implementation: index >= impl size - "
              << index << " " << region.fieldSize()
              << std::endl;
    return;
  }
 
  Range::field field;
  switch (m_specification) {
  case by_value:
  case by_label: {
    impl.set_field(Range::field(m_value, m_value));
    break;
  }
 
  case by_values:
  case by_labels: {
    impl.set_field(Range::field(m_values));
  }
  break;
 
  case by_minmax:
    impl.set_field(Range::field(m_minvalue, m_maxvalue));
    break;
 
  case unknown:
    break;
  }
}

label()

const std::string & IdDictRange::label ( ) const

inline

Definition at line 149 of file IdDictRange.h.

{
    return m_label;
}

labels()

const std::vector< std::string > & IdDictRange::labels ( ) const

inline

Definition at line 177 of file IdDictRange.h.

{
    return m_labels;
}

reset_implementation()

void IdDictRegionEntry::reset_implementation ( )

virtualinherited

Reimplemented in IdDictDictionaryRef, IdDictRangeRef, and IdDictReference.

Definition at line 22 of file IdDictRegionEntry.cxx.

                                             {
}

resolve_references()

void IdDictRange::resolve_references ( IdDictMgr & idd, IdDictDictionary & dictionary, IdDictRegion & region )

overridevirtual

The range values were unspecified in the range element.

Therefore, the set of values must be obtained from the field definition (if it exists!!).

If the field is undefined, then too bad, this range will be dummy.

Reimplemented from IdDictRegionEntry.

Definition at line 132 of file IdDictRange.cxx.

                                                                               {
  if (!m_resolved_references) {
    m_field = dictionary.find_field(m_field_name);
    if (m_field == nullptr) {
      m_field = dictionary.add_field(std::make_unique<IdDictField> (m_field_name));
    }
 
    if (m_specification == unknown) {
      unsigned int labels = m_field->get_label_number();
      if (labels == 1) {
        m_specification = by_label;
        m_label = m_field->get_label(0);
      } else if (labels > 1) {
        m_specification = by_labels;
        for (size_t i = 0; i < labels; ++i) {
          m_labels.push_back(m_field->get_label(i));
        }
      }
    }
 
    if (m_specification == by_label) {
      m_value = m_field->get_label_value(m_label);
    } else if (m_specification == by_labels) {
      m_values.clear();
      for (size_t i = 0; i < m_labels.size(); ++i) {
        const std::string& label = m_labels[i];
        int value = m_field->get_label_value(label);
        m_values.push_back(value);
      }
    }
    m_resolved_references = true;
  }
}

set_next()

void IdDictRange::set_next

(

int

next

)

Set next value and adjust continuation mode.

Definition at line 117 of file IdDictRange.cxx.

{
  m_next_value = next;
  m_continuation_mode = (m_continuation_mode == has_previous) ? has_both : has_next;
}

set_prev()

void IdDictRange::set_prev

(

int

prev

)

Set previous value and adjust continuation mode.

Definition at line 109 of file IdDictRange.cxx.

{
  m_prev_value = prev;
  m_continuation_mode = (m_continuation_mode == has_next) ? has_both : has_previous;
}

set_range() [1/5]

void IdDictRange::set_range

(

const std::string &

label

)

By label.

Definition at line 68 of file IdDictRange.cxx.

{
  m_specification = by_label;
  m_label = label;
}

set_range() [2/5]

void IdDictRange::set_range

(

const std::vector< int > &

values

)

By list of values.

Definition at line 93 of file IdDictRange.cxx.

{
  m_specification = by_values;
  m_values = values;
}

set_range() [3/5]

void IdDictRange::set_range

(

const std::vector< std::string > &

labels

)

By list of labels.

Definition at line 101 of file IdDictRange.cxx.

{
  m_specification = by_labels;
  m_labels = labels;
}

set_range() [4/5]

void IdDictRange::set_range	(	int	minvalue,
		int	maxvalue )

By minmax.

Definition at line 84 of file IdDictRange.cxx.

{
  m_specification = by_minmax;
  m_minvalue = minvalue;
  m_maxvalue = maxvalue;
}

set_range() [5/5]

void IdDictRange::set_range

(

int

value

)

By value.

Definition at line 76 of file IdDictRange.cxx.

{
  m_specification = by_value;
  m_value = value;
}

set_wrap_around()

void IdDictRange::set_wrap_around

(

)

Enable wraparound.

Definition at line 125 of file IdDictRange.cxx.

{
  m_continuation_mode = wrap_around;
}

specification()

IdDictRange::specification_type IdDictRange::specification ( ) const

inline

Definition at line 163 of file IdDictRange.h.

{
    return m_specification;
}

values()

const std::vector< int > & IdDictRange::values ( ) const

inline

Definition at line 170 of file IdDictRange.h.

{
    return m_values;
}

verify()

bool IdDictRegionEntry::verify ( ) const

virtualinherited

Reimplemented in IdDictDictionaryRef, IdDictRangeRef, and IdDictReference.

Definition at line 25 of file IdDictRegionEntry.cxx.

                                     {
  return(true);
}

Member Data Documentation

m_continuation_mode

continuation_mode IdDictRange::m_continuation_mode {none}

private

Definition at line 133 of file IdDictRange.h.

{none};

m_field

IdDictField* IdDictRange::m_field {}

private

Definition at line 123 of file IdDictRange.h.

{}; 

m_field_name

std::string IdDictRange::m_field_name

private

Definition at line 122 of file IdDictRange.h.

m_label

std::string IdDictRange::m_label

private

Definition at line 127 of file IdDictRange.h.

m_labels

std::vector<std::string> IdDictRange::m_labels

private

Definition at line 134 of file IdDictRange.h.

m_maxvalue

int IdDictRange::m_maxvalue {}

private

Definition at line 130 of file IdDictRange.h.

{};

m_minvalue

int IdDictRange::m_minvalue {}

private

Definition at line 129 of file IdDictRange.h.

{}; 

m_next_value

int IdDictRange::m_next_value {}

private

Definition at line 132 of file IdDictRange.h.

{};

m_prev_value

int IdDictRange::m_prev_value {}

private

Definition at line 131 of file IdDictRange.h.

{};

m_resolved_references

bool IdDictRange::m_resolved_references {}

private

Definition at line 137 of file IdDictRange.h.

{};

m_specification

specification_type IdDictRange::m_specification {unknown}

private

Definition at line 125 of file IdDictRange.h.

{unknown}; 

m_tag

std::string IdDictRange::m_tag

private

Definition at line 126 of file IdDictRange.h.

m_value

int IdDictRange::m_value {}

private

Definition at line 128 of file IdDictRange.h.

{}; 

m_values

std::vector<int> IdDictRange::m_values

private

Definition at line 135 of file IdDictRange.h.

---

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

• IdDictRange.h
• IdDictRange.cxx