ChainNameParser::LegInfoIterator Class Reference

Iterate over the legs of a chain. More...

#include <ChainNameParser.h>

Collaboration diagram for ChainNameParser::LegInfoIterator:

Public Types
using	iterator_category = std::input_iterator_tag
using	value_type = LegInfo
using	reference = const value_type &
using	pointer = const value_type *
using	difference_type = std::ptrdiff_t

Public Member Functions
	LegInfoIterator ()=default
	Default constructor creates a past-the-end iterator.
	LegInfoIterator (const std::string &chain)
	Create an iterator from the beginning of a chain name.
bool	operator== (const LegInfoIterator &other) const
	Check (in)equality against another iterator.
bool	operator!= (const LegInfoIterator &other) const
reference	operator* () const
	Dereference the iterator.
pointer	operator-> () const
LegInfoIterator &	operator++ ()
	pre-increment operator
LegInfoIterator	operator++ (int)
	post-increment operator
bool	exhausted () const
	Whether the iterator is exhausted.

Private Member Functions
bool	advance ()

Private Attributes
std::string::const_iterator	m_itr
std::string::const_iterator	m_end
LegInfo	m_current
std::size_t	m_peekMultiplicity {0}
std::string	m_peekSignature {""}
int	m_peekThreshold {-1}

Detailed Description

Iterate over the legs of a chain.

Definition at line 35 of file ChainNameParser.h.

Member Typedef Documentation

difference_type

using ChainNameParser::LegInfoIterator::difference_type = std::ptrdiff_t

Definition at line 42 of file ChainNameParser.h.

iterator_category

using ChainNameParser::LegInfoIterator::iterator_category = std::input_iterator_tag

Definition at line 38 of file ChainNameParser.h.

pointer

using ChainNameParser::LegInfoIterator::pointer = const value_type *

Definition at line 41 of file ChainNameParser.h.

reference

using ChainNameParser::LegInfoIterator::reference = const value_type &

Definition at line 40 of file ChainNameParser.h.

value_type

using ChainNameParser::LegInfoIterator::value_type = LegInfo

Definition at line 39 of file ChainNameParser.h.

Constructor & Destructor Documentation

LegInfoIterator() [1/2]

ChainNameParser::LegInfoIterator::LegInfoIterator ( )

default

Default constructor creates a past-the-end iterator.

LegInfoIterator() [2/2]

ChainNameParser::LegInfoIterator::LegInfoIterator

(

const std::string &

chain

)

Create an iterator from the beginning of a chain name.

Parameters

chain

The full chain name

Definition at line 78 of file ChainNameParser.cxx.

                                                           :
        m_itr(chain.begin()), m_end(chain.end())
    {
        // Move the iterator until we've found the start of a leg
        while (!advance()) {}
        // Now we have the next leg info stored in the peek variables, but not the current.
        // Advance the iterator once to store these in the current
        this->operator++();
    }

Member Function Documentation

advance()

bool ChainNameParser::LegInfoIterator::advance ( )

private

Definition at line 145 of file ChainNameParser.cxx.

    {
        std::string::const_iterator next = std::find(m_itr, m_end, '_');
        std::smatch match;
        if (std::regex_match(m_itr, next, match, legHeadRegex()))
        {
            // This means we've found the start of the next leg. Record its data and return true
            if (match.str(1).empty())
                m_peekMultiplicity = 1;
            else
                m_peekMultiplicity = std::atoi(match.str(1).c_str());
            m_peekSignature = match.str(2);
            if (match.str(3).empty())
                m_peekThreshold = -1;
            else
                m_peekThreshold = std::atoi(match.str(3).c_str());
            // Advance the iterator (skip the underscore if there is one)
            m_itr = next == m_end ? next : next + 1;
            return true;
        }
        else if (next == m_end)
        {
            m_current.legParts.emplace_back(m_itr, next);
            // Setting the iterator to the end
            m_itr = m_end;
            return true;
        }
        else
        {
            // Otherwise this is just a leg
            m_current.legParts.emplace_back(m_itr, next);
            // Advance the iterator (skip the underscore if there is one)
            m_itr = next == m_end ? next : next + 1;
            return false;
        }
    }

exhausted()

bool ChainNameParser::LegInfoIterator::exhausted

(

)

const

Whether the iterator is exhausted.

Definition at line 140 of file ChainNameParser.cxx.

    {
        return m_itr == std::string::const_iterator();
    }

operator!=()

bool ChainNameParser::LegInfoIterator::operator!=

(

const LegInfoIterator &

other

)

const

Definition at line 93 of file ChainNameParser.cxx.

    {
        return !(*this == other);
    }

operator*()

LegInfoIterator::reference ChainNameParser::LegInfoIterator::operator*

(

)

const

Dereference the iterator.

Dereferencing a past-the-end iterator returns an invalid LegInfo object

Definition at line 98 of file ChainNameParser.cxx.

    {
        return m_current;
    }

operator++() [1/2]

LegInfoIterator & ChainNameParser::LegInfoIterator::operator++

(

)

pre-increment operator

Definition at line 108 of file ChainNameParser.cxx.

    {
        if (m_peekSignature.empty() && m_itr == m_end)
        {
            // No more signatures to find, exhaust the iterator
            m_current = {};
            m_itr = std::string::const_iterator();
            m_end = std::string::const_iterator();
            m_peekMultiplicity = 0;
            m_peekThreshold = -1;
        }
        else
        {
            // Copy the peeked information into the current info
            m_current.multiplicity = m_peekMultiplicity;
            m_current.signature = m_peekSignature;
            m_current.threshold = m_peekThreshold;
            m_current.legParts.clear();
            m_peekSignature.clear();
            // Now step through until we find the next leg
            while (!advance()) {}
        }
        return *this;
    }

operator++() [2/2]

LegInfoIterator ChainNameParser::LegInfoIterator::operator++

(

int

)

post-increment operator

Definition at line 133 of file ChainNameParser.cxx.

    {
        LegInfoIterator itr(*this);
        this->operator++();
        return itr;
    }

operator->()

LegInfoIterator::pointer ChainNameParser::LegInfoIterator::operator->

(

)

const

Definition at line 103 of file ChainNameParser.cxx.

    {
        return &m_current;
    }

operator==()

bool ChainNameParser::LegInfoIterator::operator==

(

const LegInfoIterator &

other

)

const

Check (in)equality against another iterator.

Definition at line 88 of file ChainNameParser.cxx.

    {
        return m_itr == other.m_itr && m_end == other.m_end && m_peekSignature == other.m_peekSignature;
    }

Member Data Documentation

m_current

LegInfo ChainNameParser::LegInfoIterator::m_current

private

Definition at line 75 of file ChainNameParser.h.

m_end

std::string::const_iterator ChainNameParser::LegInfoIterator::m_end

private

Definition at line 74 of file ChainNameParser.h.

m_itr

std::string::const_iterator ChainNameParser::LegInfoIterator::m_itr

private

Definition at line 73 of file ChainNameParser.h.

m_peekMultiplicity

std::size_t ChainNameParser::LegInfoIterator::m_peekMultiplicity {0}

private

Definition at line 76 of file ChainNameParser.h.

{0};

m_peekSignature

std::string ChainNameParser::LegInfoIterator::m_peekSignature {""}

private

Definition at line 77 of file ChainNameParser.h.

{""};

m_peekThreshold

int ChainNameParser::LegInfoIterator::m_peekThreshold {-1}

private

Definition at line 78 of file ChainNameParser.h.

{-1};

---

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

• ChainNameParser.h
• ChainNameParser.cxx